1#!/usr/bin/env python 2 3from rpc.client import print_dict, JSONRPCException 4 5import argparse 6import rpc 7 8try: 9 from shlex import quote 10except ImportError: 11 from pipes import quote 12 13 14def print_array(a): 15 print(" ".join((quote(v) for v in a))) 16 17 18def call_cmd(func): 19 def rpc_cmd(*args, **kwargs): 20 try: 21 func(*args, **kwargs) 22 except JSONRPCException as ex: 23 print(ex.message) 24 exit(1) 25 return rpc_cmd 26 27 28if __name__ == "__main__": 29 parser = argparse.ArgumentParser( 30 description='SPDK RPC command line interface') 31 parser.add_argument('-s', dest='server_addr', 32 help='RPC server address', default='/var/tmp/spdk.sock') 33 parser.add_argument('-p', dest='port', 34 help='RPC port number (if server_addr is IP address)', 35 default=5260, type=int) 36 parser.add_argument('-t', dest='timeout', 37 help='Timout as a floating point number expressed in seconds waiting for reponse. Default: 60.0', 38 default=60.0, type=float) 39 parser.add_argument('-v', dest='verbose', 40 help='Verbose mode', action='store_true') 41 subparsers = parser.add_subparsers(help='RPC methods') 42 43 @call_cmd 44 def get_rpc_methods(args): 45 print_dict(rpc.get_rpc_methods(args.client)) 46 47 p = subparsers.add_parser('get_rpc_methods', help='Get list of supported RPC methods') 48 p.set_defaults(func=get_rpc_methods) 49 50 @call_cmd 51 def save_config(args): 52 rpc.save_config(args.client, args) 53 54 p = subparsers.add_parser('save_config', help="""Write current (live) configuration of SPDK subsystems and targets. 55 If no filename is given write configuration to stdout.""") 56 p.add_argument('-f', '--filename', help="""File where to save JSON configuration to.""") 57 p.add_argument('-i', '--indent', help="""Indent level. Value less than 0 mean compact mode. If filename is not given default 58 indent level is 2. If writing to file of filename is '-' then default is compact mode.""", type=int, default=2) 59 p.set_defaults(func=save_config) 60 61 @call_cmd 62 def load_config(args): 63 rpc.load_config(args.client, args) 64 65 p = subparsers.add_parser('load_config', help="""Configure SPDK subsystems and tagets using JSON RPC. If no file is 66 provided or file is '-' read configuration from stdin.""") 67 p.add_argument('--filename', help="""JSON Configuration file.""") 68 p.set_defaults(func=load_config) 69 70 # app 71 @call_cmd 72 def kill_instance(args): 73 rpc.app.kill_instance(args.client, args) 74 75 p = subparsers.add_parser('kill_instance', help='Send signal to instance') 76 p.add_argument('sig_name', help='signal will be sent to server.') 77 p.set_defaults(func=kill_instance) 78 79 @call_cmd 80 def context_switch_monitor(args): 81 print_dict(rpc.app.context_switch_monitor(args.client, args)) 82 83 p = subparsers.add_parser('context_switch_monitor', help='Control whether the context switch monitor is enabled') 84 p.add_argument('-e', '--enable', action='store_true', help='Enable context switch monitoring') 85 p.add_argument('-d', '--disable', action='store_true', help='Disable context switch monitoring') 86 p.set_defaults(func=context_switch_monitor) 87 88 # bdev 89 @call_cmd 90 def construct_malloc_bdev(args): 91 print_array(rpc.bdev.construct_malloc_bdev(args.client, args)) 92 93 p = subparsers.add_parser('construct_malloc_bdev', 94 help='Add a bdev with malloc backend') 95 p.add_argument('-b', '--name', help="Name of the bdev") 96 p.add_argument('-u', '--uuid', help="UUID of the bdev") 97 p.add_argument( 98 'total_size', help='Size of malloc bdev in MB (int > 0)', type=int) 99 p.add_argument('block_size', help='Block size for this bdev', type=int) 100 p.set_defaults(func=construct_malloc_bdev) 101 102 @call_cmd 103 def construct_null_bdev(args): 104 print_array(rpc.bdev.construct_null_bdev(args.client, args)) 105 106 p = subparsers.add_parser('construct_null_bdev', 107 help='Add a bdev with null backend') 108 p.add_argument('name', help='Block device name') 109 p.add_argument('-u', '--uuid', help='UUID of the bdev') 110 p.add_argument( 111 'total_size', help='Size of null bdev in MB (int > 0)', type=int) 112 p.add_argument('block_size', help='Block size for this bdev', type=int) 113 p.set_defaults(func=construct_null_bdev) 114 115 @call_cmd 116 def construct_aio_bdev(args): 117 print_array(rpc.bdev.construct_aio_bdev(args.client, args)) 118 119 p = subparsers.add_parser('construct_aio_bdev', 120 help='Add a bdev with aio backend') 121 p.add_argument('filename', help='Path to device or file (ex: /dev/sda)') 122 p.add_argument('name', help='Block device name') 123 p.add_argument('block_size', help='Block size for this bdev', type=int, default=argparse.SUPPRESS) 124 p.set_defaults(func=construct_aio_bdev) 125 126 @call_cmd 127 def construct_nvme_bdev(args): 128 print_array(rpc.bdev.construct_nvme_bdev(args.client, args)) 129 130 p = subparsers.add_parser('construct_nvme_bdev', 131 help='Add bdev with nvme backend') 132 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 133 p.add_argument('-t', '--trtype', 134 help='NVMe-oF target trtype: e.g., rdma, pcie', required=True) 135 p.add_argument('-a', '--traddr', 136 help='NVMe-oF target address: e.g., an ip address or BDF', required=True) 137 p.add_argument('-f', '--adrfam', 138 help='NVMe-oF target adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 139 p.add_argument('-s', '--trsvcid', 140 help='NVMe-oF target trsvcid: e.g., a port number') 141 p.add_argument('-n', '--subnqn', help='NVMe-oF target subnqn') 142 p.set_defaults(func=construct_nvme_bdev) 143 144 @call_cmd 145 def construct_rbd_bdev(args): 146 print_array(rpc.bdev.construct_rbd_bdev(args.client, args)) 147 148 p = subparsers.add_parser('construct_rbd_bdev', 149 help='Add a bdev with ceph rbd backend') 150 p.add_argument('-b', '--name', help="Name of the bdev", required=False) 151 p.add_argument('pool_name', help='rbd pool name') 152 p.add_argument('rbd_name', help='rbd image name') 153 p.add_argument('block_size', help='rbd block size', type=int) 154 p.set_defaults(func=construct_rbd_bdev) 155 156 @call_cmd 157 def construct_error_bdev(args): 158 rpc.bdev.construct_error_bdev(args.client, args) 159 160 p = subparsers.add_parser('construct_error_bdev', 161 help='Add bdev with error injection backend') 162 p.add_argument('base_name', help='base bdev name') 163 p.set_defaults(func=construct_error_bdev) 164 165 @call_cmd 166 def construct_pmem_bdev(args): 167 print_array(rpc.bdev.construct_pmem_bdev(args.client, args)) 168 169 p = subparsers.add_parser('construct_pmem_bdev', help='Add a bdev with pmem backend') 170 p.add_argument('pmem_file', help='Path to pmemblk pool file') 171 p.add_argument('-n', '--name', help='Block device name', required=True) 172 p.set_defaults(func=construct_pmem_bdev) 173 174 @call_cmd 175 def get_bdevs(args): 176 print_dict(rpc.bdev.get_bdevs(args.client, args)) 177 178 p = subparsers.add_parser( 179 'get_bdevs', help='Display current blockdev list or required blockdev') 180 p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1", required=False) 181 p.set_defaults(func=get_bdevs) 182 183 @call_cmd 184 def get_bdevs_config(args): 185 print_dict(rpc.bdev.get_bdevs_config(args.client, args)) 186 187 p = subparsers.add_parser( 188 'get_bdevs_config', help='Display current (live) blockdev configuration list or required blockdev') 189 p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1", required=False) 190 p.set_defaults(func=get_bdevs_config) 191 192 @call_cmd 193 def delete_bdev(args): 194 rpc.bdev.delete_bdev(args.client, args) 195 196 p = subparsers.add_parser('delete_bdev', help='Delete a blockdev') 197 p.add_argument( 198 'bdev_name', help='Blockdev name to be deleted. Example: Malloc0.') 199 p.set_defaults(func=delete_bdev) 200 201 @call_cmd 202 def bdev_inject_error(args): 203 rpc.bdev.bdev_inject_error(args.client, args) 204 205 p = subparsers.add_parser('bdev_inject_error', help='bdev inject error') 206 p.add_argument('name', help="""the name of the error injection bdev""") 207 p.add_argument('io_type', help="""io_type: 'clear' 'read' 'write' 'unmap' 'flush' 'all'""") 208 p.add_argument('error_type', help="""error_type: 'failure' 'pending'""") 209 p.add_argument( 210 '-n', '--num', help='the number of commands you want to fail', type=int, default=1) 211 p.set_defaults(func=bdev_inject_error) 212 213 @call_cmd 214 def apply_firmware(args): 215 print_dict(rpc.bdev.apply_firmware(args.client, args)) 216 217 p = subparsers.add_parser('apply_firmware', help='Download and commit firmware to NVMe device') 218 p.add_argument('filename', help='filename of the firmware to download') 219 p.add_argument('bdev_name', help='name of the NVMe device') 220 p.set_defaults(func=apply_firmware) 221 222 # iSCSI 223 @call_cmd 224 def get_portal_groups(args): 225 print_dict(rpc.iscsi.get_portal_groups(args.client, args)) 226 227 p = subparsers.add_parser( 228 'get_portal_groups', help='Display current portal group configuration') 229 p.set_defaults(func=get_portal_groups) 230 231 @call_cmd 232 def get_initiator_groups(args): 233 print_dict(rpc.iscsi.get_initiator_groups(args.client, args)) 234 235 p = subparsers.add_parser('get_initiator_groups', 236 help='Display current initiator group configuration') 237 p.set_defaults(func=get_initiator_groups) 238 239 @call_cmd 240 def get_target_nodes(args): 241 print_dict(rpc.iscsi.get_target_nodes(args.client, args)) 242 243 p = subparsers.add_parser('get_target_nodes', help='Display target nodes') 244 p.set_defaults(func=get_target_nodes) 245 246 @call_cmd 247 def construct_target_node(args): 248 rpc.iscsi.construct_target_node(args.client, args) 249 250 p = subparsers.add_parser('construct_target_node', 251 help='Add a target node') 252 p.add_argument('name', help='Target node name (ASCII)') 253 p.add_argument('alias_name', help='Target node alias name (ASCII)') 254 p.add_argument('bdev_name_id_pairs', help="""Whitespace-separated list of <bdev name:LUN ID> pairs enclosed 255 in quotes. Format: 'bdev_name0:id0 bdev_name1:id1' etc 256 Example: 'Malloc0:0 Malloc1:1 Malloc5:2' 257 *** The bdevs must pre-exist *** 258 *** LUN0 (id = 0) is required *** 259 *** bdevs names cannot contain space or colon characters ***""") 260 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings 261 Whitespace separated, quoted, mapping defined with colon 262 separated list of "tags" (int > 0) 263 Example: '1:1 2:2 2:1' 264 *** The Portal/Initiator Groups must be precreated ***""") 265 p.add_argument('queue_depth', help='Desired target queue depth', type=int) 266 p.add_argument('-g', '--chap-group', help="""Authentication group ID for this target node. 267 *** Authentication group must be precreated ***""", type=int, default=0) 268 p.add_argument('-d', '--disable-chap', help="""CHAP authentication should be disabled for this target node. 269 *** Mutually exclusive with --require-chap ***""", action='store_true') 270 p.add_argument('-r', '--require-chap', help="""CHAP authentication should be required for this target node. 271 *** Mutually exclusive with --disable-chap ***""", action='store_true') 272 p.add_argument( 273 '-m', '--mutual-chap', help='CHAP authentication should be mutual/bidirectional.', action='store_true') 274 p.add_argument('-H', '--header-digest', 275 help='Header Digest should be required for this target node.', action='store_true') 276 p.add_argument('-D', '--data-digest', 277 help='Data Digest should be required for this target node.', action='store_true') 278 p.set_defaults(func=construct_target_node) 279 280 @call_cmd 281 def target_node_add_lun(args): 282 rpc.iscsi.target_node_add_lun(args.client, args) 283 284 p = subparsers.add_parser('target_node_add_lun', help='Add LUN to the target node') 285 p.add_argument('name', help='Target node name (ASCII)') 286 p.add_argument('bdev_name', help="""bdev name enclosed in quotes. 287 *** bdev name cannot contain space or colon characters ***""") 288 p.add_argument('-i', dest='lun_id', help="""LUN ID (integer >= 0) 289 *** If LUN ID is omitted or -1, the lowest free one is assigned ***""", type=int, required=False) 290 p.set_defaults(func=target_node_add_lun) 291 292 @call_cmd 293 def add_pg_ig_maps(args): 294 rpc.iscsi.add_pg_ig_maps(args.client, args) 295 296 p = subparsers.add_parser('add_pg_ig_maps', help='Add PG-IG maps to the target node') 297 p.add_argument('name', help='Target node name (ASCII)') 298 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings 299 Whitespace separated, quoted, mapping defined with colon 300 separated list of "tags" (int > 0) 301 Example: '1:1 2:2 2:1' 302 *** The Portal/Initiator Groups must be precreated ***""") 303 p.set_defaults(func=add_pg_ig_maps) 304 305 @call_cmd 306 def delete_pg_ig_maps(args): 307 rpc.iscsi.delete_pg_ig_maps(args.client, args) 308 309 p = subparsers.add_parser('delete_pg_ig_maps', help='Delete PG-IG maps from the target node') 310 p.add_argument('name', help='Target node name (ASCII)') 311 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings 312 Whitespace separated, quoted, mapping defined with colon 313 separated list of "tags" (int > 0) 314 Example: '1:1 2:2 2:1' 315 *** The Portal/Initiator Groups must be precreated ***""") 316 p.set_defaults(func=delete_pg_ig_maps) 317 318 @call_cmd 319 def add_portal_group(args): 320 rpc.iscsi.add_portal_group(args.client, args) 321 322 p = subparsers.add_parser('add_portal_group', help='Add a portal group') 323 p.add_argument( 324 'tag', help='Portal group tag (unique, integer > 0)', type=int) 325 p.add_argument('portal_list', nargs=argparse.REMAINDER, help="""List of portals in 'host:port@cpumask' format, separated by whitespace 326 (cpumask is optional and can be skipped) 327 Example: '192.168.100.100:3260' '192.168.100.100:3261' '192.168.100.100:3262@0x1""") 328 p.set_defaults(func=add_portal_group) 329 330 @call_cmd 331 def add_initiator_group(args): 332 rpc.iscsi.add_initiator_group(args.client, args) 333 334 p = subparsers.add_parser('add_initiator_group', 335 help='Add an initiator group') 336 p.add_argument( 337 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 338 p.add_argument('initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses, 339 enclosed in quotes. Example: 'ANY' or '127.0.0.1 192.168.200.100'""") 340 p.add_argument('netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes. 341 Example: '255.255.0.0 255.248.0.0' etc""") 342 p.set_defaults(func=add_initiator_group) 343 344 @call_cmd 345 def add_initiators_to_initiator_group(args): 346 rpc.iscsi.add_initiators_to_initiator_group(args.client, args) 347 348 p = subparsers.add_parser('add_initiators_to_initiator_group', 349 help='Add initiators to an existing initiator group') 350 p.add_argument( 351 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 352 p.add_argument('-n', dest='initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses, 353 enclosed in quotes. This parameter can be omitted. Example: 'ANY' or '127.0.0.1 192.168.200.100'""", required=False) 354 p.add_argument('-m', dest='netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes. 355 This parameter can be omitted. Example: '255.255.0.0 255.248.0.0' etc""", required=False) 356 p.set_defaults(func=add_initiators_to_initiator_group) 357 358 @call_cmd 359 def delete_initiators_from_initiator_group(args): 360 rpc.iscsi.delete_initiators_from_initiator_group(args.client, args) 361 362 p = subparsers.add_parser('delete_initiators_from_initiator_group', 363 help='Delete initiators from an existing initiator group') 364 p.add_argument( 365 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 366 p.add_argument('-n', dest='initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses, 367 enclosed in quotes. This parameter can be omitted. Example: 'ANY' or '127.0.0.1 192.168.200.100'""", required=False) 368 p.add_argument('-m', dest='netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes. 369 This parameter can be omitted. Example: '255.255.0.0 255.248.0.0' etc""", required=False) 370 p.set_defaults(func=delete_initiators_from_initiator_group) 371 372 @call_cmd 373 def delete_target_node(args): 374 rpc.iscsi.delete_target_node(args.client, args) 375 376 p = subparsers.add_parser('delete_target_node', 377 help='Delete a target node') 378 p.add_argument('target_node_name', 379 help='Target node name to be deleted. Example: iqn.2016-06.io.spdk:disk1.') 380 p.set_defaults(func=delete_target_node) 381 382 @call_cmd 383 def delete_portal_group(args): 384 rpc.iscsi.delete_portal_group(args.client, args) 385 386 p = subparsers.add_parser('delete_portal_group', 387 help='Delete a portal group') 388 p.add_argument( 389 'tag', help='Portal group tag (unique, integer > 0)', type=int) 390 p.set_defaults(func=delete_portal_group) 391 392 @call_cmd 393 def delete_initiator_group(args): 394 rpc.iscsi.delete_initiator_group(args.client, args) 395 396 p = subparsers.add_parser('delete_initiator_group', 397 help='Delete an initiator group') 398 p.add_argument( 399 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 400 p.set_defaults(func=delete_initiator_group) 401 402 @call_cmd 403 def get_iscsi_connections(args): 404 print_dict(rpc.iscsi.get_iscsi_connections(args.client, args)) 405 406 p = subparsers.add_parser('get_iscsi_connections', 407 help='Display iSCSI connections') 408 p.set_defaults(func=get_iscsi_connections) 409 410 @call_cmd 411 def get_iscsi_global_params(args): 412 print_dict(rpc.iscsi.get_iscsi_global_params(args.client, args)) 413 414 p = subparsers.add_parser('get_iscsi_global_params', help='Display iSCSI global parameters') 415 p.set_defaults(func=get_iscsi_global_params) 416 417 @call_cmd 418 def get_scsi_devices(args): 419 print_dict(rpc.iscsi.get_scsi_devices(args.client, args)) 420 421 p = subparsers.add_parser('get_scsi_devices', help='Display SCSI devices') 422 p.set_defaults(func=get_scsi_devices) 423 424 # log 425 @call_cmd 426 def set_trace_flag(args): 427 rpc.log.set_trace_flag(args.client, args) 428 429 p = subparsers.add_parser('set_trace_flag', help='set trace flag') 430 p.add_argument( 431 'flag', help='trace mask we want to set. (for example "debug").') 432 p.set_defaults(func=set_trace_flag) 433 434 @call_cmd 435 def clear_trace_flag(args): 436 rpc.log.clear_trace_flag(args.client, args) 437 438 p = subparsers.add_parser('clear_trace_flag', help='clear trace flag') 439 p.add_argument( 440 'flag', help='trace mask we want to clear. (for example "debug").') 441 p.set_defaults(func=clear_trace_flag) 442 443 @call_cmd 444 def get_trace_flags(args): 445 print_dict(rpc.log.get_trace_flags(args.client, args)) 446 447 p = subparsers.add_parser('get_trace_flags', help='get trace flags') 448 p.set_defaults(func=get_trace_flags) 449 450 @call_cmd 451 def set_log_level(args): 452 rpc.log.set_log_level(args.client, args) 453 454 p = subparsers.add_parser('set_log_level', help='set log level') 455 p.add_argument('level', help='log level we want to set. (for example "DEBUG").') 456 p.set_defaults(func=set_log_level) 457 458 @call_cmd 459 def get_log_level(args): 460 print_dict(rpc.log.get_log_level(args.client, args)) 461 462 p = subparsers.add_parser('get_log_level', help='get log level') 463 p.set_defaults(func=get_log_level) 464 465 @call_cmd 466 def set_log_print_level(args): 467 rpc.log.set_log_print_level(args.client, args) 468 469 p = subparsers.add_parser('set_log_print_level', help='set log print level') 470 p.add_argument('level', help='log print level we want to set. (for example "DEBUG").') 471 p.set_defaults(func=set_log_print_level) 472 473 @call_cmd 474 def get_log_print_level(args): 475 print_dict(rpc.log.get_log_print_level(args.client, args)) 476 477 p = subparsers.add_parser('get_log_print_level', help='get log print level') 478 p.set_defaults(func=get_log_print_level) 479 480 # lvol 481 @call_cmd 482 def construct_lvol_store(args): 483 print_array(rpc.lvol.construct_lvol_store(args.client, 484 bdev_name=args.bdev_name, 485 lvs_name=args.lvs_name, 486 cluster_sz=args.cluster_sz)) 487 488 p = subparsers.add_parser('construct_lvol_store', help='Add logical volume store on base bdev') 489 p.add_argument('bdev_name', help='base bdev name') 490 p.add_argument('lvs_name', help='name for lvol store') 491 p.add_argument('-c', '--cluster-sz', help='size of cluster (in bytes)', type=int, required=False) 492 p.set_defaults(func=construct_lvol_store) 493 494 @call_cmd 495 def rename_lvol_store(args): 496 rpc.lvol.rename_lvol_store(args.client, 497 old_name=args.old_name, 498 new_name=args.new_name) 499 500 p = subparsers.add_parser('rename_lvol_store', help='Change logical volume store name') 501 p.add_argument('old_name', help='old name') 502 p.add_argument('new_name', help='new name') 503 p.set_defaults(func=rename_lvol_store) 504 505 @call_cmd 506 def construct_lvol_bdev(args): 507 print_array(rpc.lvol.construct_lvol_bdev(args.client, 508 lvol_name=args.lvol_name, 509 size=args.size * 1024 * 1024, 510 thin_provision=args.thin_provision, 511 uuid=args.uuid, 512 lvs_name=args.lvs_name)) 513 514 p = subparsers.add_parser('construct_lvol_bdev', help='Add a bdev with an logical volume backend') 515 p.add_argument('-u', '--uuid', help='lvol store UUID', required=False) 516 p.add_argument('-l', '--lvs_name', help='lvol store name', required=False) 517 p.add_argument('-t', '--thin-provision', action='store_true', help='create lvol bdev as thin provisioned') 518 p.add_argument('lvol_name', help='name for this lvol') 519 p.add_argument('size', help='size in MiB for this bdev', type=int) 520 p.set_defaults(func=construct_lvol_bdev) 521 522 @call_cmd 523 def snapshot_lvol_bdev(args): 524 rpc.lvol.snapshot_lvol_bdev(args.client, 525 lvol_name=args.lvol_name, 526 snapshot_name=args.snapshot_name) 527 528 p = subparsers.add_parser('snapshot_lvol_bdev', help='Create a snapshot of an lvol bdev') 529 p.add_argument('lvol_name', help='lvol bdev name') 530 p.add_argument('snapshot_name', help='lvol snapshot name') 531 p.set_defaults(func=snapshot_lvol_bdev) 532 533 @call_cmd 534 def clone_lvol_bdev(args): 535 rpc.lvol.clone_lvol_bdev(args.client, 536 snapshot_name=args.snapshot_name, 537 clone_name=args.clone_name) 538 539 p = subparsers.add_parser('clone_lvol_bdev', help='Create a clone of an lvol snapshot') 540 p.add_argument('snapshot_name', help='lvol snapshot name') 541 p.add_argument('clone_name', help='lvol clone name') 542 p.set_defaults(func=clone_lvol_bdev) 543 544 @call_cmd 545 def rename_lvol_bdev(args): 546 rpc.lvol.rename_lvol_bdev(args.client, 547 old_name=args.old_name, 548 new_name=args.new_name) 549 550 p = subparsers.add_parser('rename_lvol_bdev', help='Change lvol bdev name') 551 p.add_argument('old_name', help='lvol bdev name') 552 p.add_argument('new_name', help='new lvol name') 553 p.set_defaults(func=rename_lvol_bdev) 554 555 @call_cmd 556 def resize_lvol_bdev(args): 557 rpc.lvol.resize_lvol_bdev(args.client, 558 name=args.name, 559 size=args.size * 1024 * 1024) 560 561 p = subparsers.add_parser('resize_lvol_bdev', help='Resize existing lvol bdev') 562 p.add_argument('name', help='lvol bdev name') 563 p.add_argument('size', help='new size in MiB for this bdev', type=int) 564 p.set_defaults(func=resize_lvol_bdev) 565 566 @call_cmd 567 def destroy_lvol_store(args): 568 rpc.lvol.destroy_lvol_store(args.client, 569 uuid=args.uuid, 570 lvs_name=args.lvs_name) 571 572 p = subparsers.add_parser('destroy_lvol_store', help='Destroy an logical volume store') 573 p.add_argument('-u', '--uuid', help='lvol store UUID', required=False) 574 p.add_argument('-l', '--lvs_name', help='lvol store name', required=False) 575 p.set_defaults(func=destroy_lvol_store) 576 577 @call_cmd 578 def get_lvol_stores(args): 579 print_dict(rpc.lvol.get_lvol_stores(args.client, 580 uuid=args.uuid, 581 lvs_name=args.lvs_name)) 582 583 p = subparsers.add_parser('get_lvol_stores', help='Display current logical volume store list') 584 p.add_argument('-u', '--uuid', help='lvol store UUID', required=False) 585 p.add_argument('-l', '--lvs_name', help='lvol store name', required=False) 586 p.set_defaults(func=get_lvol_stores) 587 588 # split 589 def construct_split_vbdev(args): 590 print_dict(rpc.bdev.construct_split_vbdev(args.client, args)) 591 592 p = subparsers.add_parser('construct_split_vbdev', help="""Add given disk name to split config. If bdev with base_name 593 name exist the split bdevs will be created right away, if not split bdevs will be created when base bdev became 594 available (during examination process).""") 595 p.add_argument('base_bdev', help='base bdev name') 596 p.add_argument('-s', '--split_size_mb', help='size in MiB for each bdev', type=int, default=0) 597 p.add_argument('split_count', help="""Optional - number of split bdevs to create. Total size * split_count must not 598 exceed the base bdev size.""", type=int) 599 p.set_defaults(func=construct_split_vbdev) 600 601 def destruct_split_vbdev(args): 602 rpc.destruct_split_vbdev(args.client, args) 603 604 p = subparsers.add_parser('destruct_split_vbdev', help="""Delete split config with all created splits.""") 605 p.add_argument('base_bdev', help='base bdev name') 606 p.set_defaults(func=destruct_split_vbdev) 607 608 # nbd 609 @call_cmd 610 def start_nbd_disk(args): 611 rpc.nbd.start_nbd_disk(args.client, 612 bdev_name=args.bdev_name, 613 nbd_device=args.nbd_device) 614 615 p = subparsers.add_parser('start_nbd_disk', help='Export a bdev as a nbd disk') 616 p.add_argument('bdev_name', help='Blockdev name to be exported. Example: Malloc0.') 617 p.add_argument('nbd_device', help='Nbd device name to be assigned. Example: /dev/nbd0.') 618 p.set_defaults(func=start_nbd_disk) 619 620 @call_cmd 621 def stop_nbd_disk(args): 622 rpc.nbd.stop_nbd_disk(args.client, 623 nbd_device=args.nbd_device) 624 625 p = subparsers.add_parser('stop_nbd_disk', help='Stop a nbd disk') 626 p.add_argument('nbd_device', help='Nbd device name to be stopped. Example: /dev/nbd0.') 627 p.set_defaults(func=stop_nbd_disk) 628 629 @call_cmd 630 def get_nbd_disks(args): 631 print_dict(rpc.nbd.get_nbd_disks(args.client, 632 nbd_device=args.nbd_device)) 633 634 p = subparsers.add_parser('get_nbd_disks', help='Display full or specified nbd device list') 635 p.add_argument('-n', '--nbd_device', help="Path of the nbd device. Example: /dev/nbd0", required=False) 636 p.set_defaults(func=get_nbd_disks) 637 638 # net 639 @call_cmd 640 def add_ip_address(args): 641 rpc.net.add_ip_address(args.client, args) 642 643 p = subparsers.add_parser('add_ip_address', help='Add IP address') 644 p.add_argument('ifc_index', help='ifc index of the nic device.', type=int) 645 p.add_argument('ip_addr', help='ip address will be added.') 646 p.set_defaults(func=add_ip_address) 647 648 @call_cmd 649 def delete_ip_address(args): 650 rpc.net.delete_ip_address(args.client, args) 651 652 p = subparsers.add_parser('delete_ip_address', help='Delete IP address') 653 p.add_argument('ifc_index', help='ifc index of the nic device.', type=int) 654 p.add_argument('ip_addr', help='ip address will be deleted.') 655 p.set_defaults(func=delete_ip_address) 656 657 @call_cmd 658 def get_interfaces(args): 659 print_dict(rpc.net.get_interfaces(args.client, args)) 660 661 p = subparsers.add_parser( 662 'get_interfaces', help='Display current interface list') 663 p.set_defaults(func=get_interfaces) 664 665 # NVMe-oF 666 @call_cmd 667 def get_nvmf_subsystems(args): 668 print_dict(rpc.nvmf.get_nvmf_subsystems(args.client, args)) 669 670 p = subparsers.add_parser('get_nvmf_subsystems', 671 help='Display nvmf subsystems') 672 p.set_defaults(func=get_nvmf_subsystems) 673 674 @call_cmd 675 def construct_nvmf_subsystem(args): 676 rpc.nvmf.construct_nvmf_subsystem(args.client, args) 677 678 p = subparsers.add_parser('construct_nvmf_subsystem', help='Add a nvmf subsystem') 679 p.add_argument('nqn', help='Target nqn(ASCII)') 680 p.add_argument('listen', help="""comma-separated list of Listen <trtype:transport_name traddr:address trsvcid:port_id> pairs enclosed 681 in quotes. Format: 'trtype:transport0 traddr:traddr0 trsvcid:trsvcid0,trtype:transport1 traddr:traddr1 trsvcid:trsvcid1' etc 682 Example: 'trtype:RDMA traddr:192.168.100.8 trsvcid:4420,trtype:RDMA traddr:192.168.100.9 trsvcid:4420'""") 683 p.add_argument('hosts', help="""Whitespace-separated list of host nqn list. 684 Format: 'nqn1 nqn2' etc 685 Example: 'nqn.2016-06.io.spdk:init nqn.2016-07.io.spdk:init'""") 686 p.add_argument("-a", "--allow-any-host", action='store_true', help="Allow any host to connect (don't enforce host NQN whitelist)") 687 p.add_argument("-s", "--serial_number", help=""" 688 Format: 'sn' etc 689 Example: 'SPDK00000000000001'""", default='0000:00:01.0') 690 p.add_argument("-n", "--namespaces", help="""Whitespace-separated list of namespaces 691 Format: 'bdev_name1[:nsid1] bdev_name2[:nsid2] bdev_name3[:nsid3]' etc 692 Example: '1:Malloc0 2:Malloc1 3:Malloc2' 693 *** The devices must pre-exist ***""") 694 p.add_argument("-m", "--max-namespaces", help="Maximum number of namespaces allowed to added during active connection", 695 type=int, default=0) 696 p.set_defaults(func=construct_nvmf_subsystem) 697 698 @call_cmd 699 def delete_nvmf_subsystem(args): 700 rpc.nvmf.delete_nvmf_subsystem(args.client, args) 701 702 p = subparsers.add_parser('delete_nvmf_subsystem', 703 help='Delete a nvmf subsystem') 704 p.add_argument('subsystem_nqn', 705 help='subsystem nqn to be deleted. Example: nqn.2016-06.io.spdk:cnode1.') 706 p.set_defaults(func=delete_nvmf_subsystem) 707 708 @call_cmd 709 def nvmf_subsystem_add_listener(args): 710 rpc.nvmf.nvmf_subsystem_add_listener(args.client, args) 711 712 p = subparsers.add_parser('nvmf_subsystem_add_listener', help='Add a listener to an NVMe-oF subsystem') 713 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 714 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True) 715 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True) 716 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 717 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number') 718 p.set_defaults(func=nvmf_subsystem_add_listener) 719 720 @call_cmd 721 def nvmf_subsystem_remove_listener(args): 722 rpc.nvmf.nvmf_subsystem_remove_listener(args.client, args) 723 724 p = subparsers.add_parser('nvmf_subsystem_remove_listener', help='Remove a listener from an NVMe-oF subsystem') 725 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 726 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True) 727 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True) 728 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 729 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number') 730 p.set_defaults(func=nvmf_subsystem_remove_listener) 731 732 @call_cmd 733 def nvmf_subsystem_add_ns(args): 734 rpc.nvmf.nvmf_subsystem_add_ns(args.client, args) 735 736 p = subparsers.add_parser('nvmf_subsystem_add_ns', help='Add a namespace to an NVMe-oF subsystem') 737 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 738 p.add_argument('bdev_name', help='The name of the bdev that will back this namespace') 739 p.add_argument('-n', '--nsid', help='The requested NSID (optional)', type=int) 740 p.add_argument('-g', '--nguid', help='Namespace globally unique identifier (optional)') 741 p.add_argument('-e', '--eui64', help='Namespace EUI-64 identifier (optional)') 742 p.set_defaults(func=nvmf_subsystem_add_ns) 743 744 @call_cmd 745 def nvmf_subsystem_remove_ns(args): 746 rpc.nvmf.nvmf_subsystem_remove_ns(args.client, args) 747 748 p = subparsers.add_parser('nvmf_subsystem_remove_ns', help='Remove a namespace to an NVMe-oF subsystem') 749 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 750 p.add_argument('nsid', help='The requested NSID', type=int) 751 p.set_defaults(func=nvmf_subsystem_remove_ns) 752 753 @call_cmd 754 def nvmf_subsystem_add_host(args): 755 rpc.nvmf.nvmf_subsystem_add_host(args.client, args) 756 757 p = subparsers.add_parser('nvmf_subsystem_add_host', help='Add a host to an NVMe-oF subsystem') 758 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 759 p.add_argument('host', help='Host NQN to allow') 760 p.set_defaults(func=nvmf_subsystem_add_host) 761 762 @call_cmd 763 def nvmf_subsystem_remove_host(args): 764 rpc.nvmf.nvmf_subsystem_remove_host(args.client, args) 765 766 p = subparsers.add_parser('nvmf_subsystem_remove_host', help='Remove a host from an NVMe-oF subsystem') 767 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 768 p.add_argument('host', help='Host NQN to remove') 769 p.set_defaults(func=nvmf_subsystem_remove_host) 770 771 @call_cmd 772 def nvmf_subsystem_allow_any_host(args): 773 rpc.nvmf.nvmf_subsystem_allow_any_host(args.client, args) 774 775 p = subparsers.add_parser('nvmf_subsystem_allow_any_host', help='Allow any host to connect to the subsystem') 776 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 777 p.add_argument('-e', '--enable', action='store_true', help='Enable allowing any host') 778 p.add_argument('-d', '--disable', action='store_true', help='Disable allowing any host') 779 p.set_defaults(func=nvmf_subsystem_allow_any_host) 780 781 # pmem 782 @call_cmd 783 def create_pmem_pool(args): 784 rpc.pmem.create_pmem_pool(args.client, args) 785 786 p = subparsers.add_parser('create_pmem_pool', help='Create pmem pool') 787 p.add_argument('pmem_file', help='Path to pmemblk pool file') 788 p.add_argument('total_size', help='Size of malloc bdev in MB (int > 0)', type=int) 789 p.add_argument('block_size', help='Block size for this pmem pool', type=int) 790 p.set_defaults(func=create_pmem_pool) 791 792 @call_cmd 793 def pmem_pool_info(args): 794 print_dict(rpc.pmem.pmem_pool_info(args.client, args)) 795 796 p = subparsers.add_parser('pmem_pool_info', help='Display pmem pool info and check consistency') 797 p.add_argument('pmem_file', help='Path to pmemblk pool file') 798 p.set_defaults(func=pmem_pool_info) 799 800 @call_cmd 801 def delete_pmem_pool(args): 802 rpc.pmem.delete_pmem_pool(args.client, args) 803 804 p = subparsers.add_parser('delete_pmem_pool', help='Delete pmem pool') 805 p.add_argument('pmem_file', help='Path to pmemblk pool file') 806 p.set_defaults(func=delete_pmem_pool) 807 808 # subsystem 809 @call_cmd 810 def get_subsystems(args): 811 print_dict(rpc.subsystem.get_subsystems(args.client)) 812 813 p = subparsers.add_parser('get_subsystems', help="""Print subsystems array in initialization order. Each subsystem 814 entry contain (unsorted) array of subsystems it depends on.""") 815 p.set_defaults(func=get_subsystems) 816 817 @call_cmd 818 def get_subsystem_config(args): 819 print_dict(rpc.subsystem.get_subsystem_config(args.client, args.name)) 820 821 p = subparsers.add_parser('get_subsystem_config', help="""Print subsystem configuration""") 822 p.add_argument('name', help='Name of subsystem to query') 823 p.set_defaults(func=get_subsystem_config) 824 825 # vhost 826 @call_cmd 827 def set_vhost_controller_coalescing(args): 828 rpc.vhost.set_vhost_controller_coalescing(args.client, args) 829 830 p = subparsers.add_parser('set_vhost_controller_coalescing', help='Set vhost controller coalescing') 831 p.add_argument('ctrlr', help='controller name') 832 p.add_argument('delay_base_us', help='Base delay time', type=int) 833 p.add_argument('iops_threshold', help='IOPS threshold when coalescing is enabled', type=int) 834 p.set_defaults(func=set_vhost_controller_coalescing) 835 836 @call_cmd 837 def construct_vhost_scsi_controller(args): 838 rpc.vhost.construct_vhost_scsi_controller(args.client, args) 839 840 p = subparsers.add_parser( 841 'construct_vhost_scsi_controller', help='Add new vhost controller') 842 p.add_argument('ctrlr', help='controller name') 843 p.add_argument('--cpumask', help='cpu mask for this controller') 844 p.set_defaults(func=construct_vhost_scsi_controller) 845 846 @call_cmd 847 def add_vhost_scsi_lun(args): 848 rpc.vhost.add_vhost_scsi_lun(args.client, args) 849 850 p = subparsers.add_parser('add_vhost_scsi_lun', 851 help='Add lun to vhost controller') 852 p.add_argument('ctrlr', help='conntroller name where add lun') 853 p.add_argument('scsi_target_num', help='scsi_target_num', type=int) 854 p.add_argument('bdev_name', help='bdev name') 855 p.set_defaults(func=add_vhost_scsi_lun) 856 857 @call_cmd 858 def remove_vhost_scsi_target(args): 859 rpc.vhost.remove_vhost_scsi_target(args.client, args) 860 861 p = subparsers.add_parser('remove_vhost_scsi_target', help='Remove target from vhost controller') 862 p.add_argument('ctrlr', help='controller name to remove target from') 863 p.add_argument('scsi_target_num', help='scsi_target_num', type=int) 864 p.set_defaults(func=remove_vhost_scsi_target) 865 866 @call_cmd 867 def construct_vhost_blk_controller(args): 868 rpc.vhost.construct_vhost_blk_controller(args.client, args) 869 870 p = subparsers.add_parser('construct_vhost_blk_controller', help='Add a new vhost block controller') 871 p.add_argument('ctrlr', help='controller name') 872 p.add_argument('dev_name', help='device name') 873 p.add_argument('--cpumask', help='cpu mask for this controller') 874 p.add_argument("-r", "--readonly", action='store_true', help='Set controller as read-only') 875 p.set_defaults(func=construct_vhost_blk_controller) 876 877 @call_cmd 878 def get_vhost_controllers(args): 879 print_dict(rpc.vhost.get_vhost_controllers(args.client, args)) 880 881 p = subparsers.add_parser('get_vhost_controllers', help='List vhost controllers') 882 p.set_defaults(func=get_vhost_controllers) 883 884 @call_cmd 885 def remove_vhost_controller(args): 886 rpc.vhost.remove_vhost_controller(args.client, args) 887 888 p = subparsers.add_parser('remove_vhost_controller', help='Remove a vhost controller') 889 p.add_argument('ctrlr', help='controller name') 890 p.set_defaults(func=remove_vhost_controller) 891 892 @call_cmd 893 def construct_virtio_user_scsi_bdev(args): 894 print_dict(rpc.vhost.construct_virtio_user_scsi_bdev(args.client, args)) 895 896 p = subparsers.add_parser('construct_virtio_user_scsi_bdev', help="""Connect to virtio user scsi device. 897 This imply scan and add bdevs offered by remote side. 898 Result is array of added bdevs.""") 899 p.add_argument('path', help='Path to Virtio SCSI socket') 900 p.add_argument('name', help="""Use this name as base instead of 'VirtioScsiN' 901 Base will be used to construct new bdev's found on target by adding 't<TARGET_ID>' sufix.""") 902 p.add_argument('--vq-count', help='Number of virtual queues to be used.', type=int) 903 p.add_argument('--vq-size', help='Size of each queue', type=int) 904 p.set_defaults(func=construct_virtio_user_scsi_bdev) 905 906 @call_cmd 907 def construct_virtio_pci_scsi_bdev(args): 908 print_dict(rpc.vhost.construct_virtio_pci_scsi_bdev(args.client, args)) 909 910 p = subparsers.add_parser('construct_virtio_pci_scsi_bdev', help="""Create a Virtio 911 SCSI device from a virtio-pci device.""") 912 p.add_argument('pci_address', help="""PCI address in domain:bus:device.function format or 913 domain.bus.device.function format""") 914 p.add_argument('name', help="""Name for the virtio device. 915 It will be inhereted by all created bdevs, which are named n the following format: <name>t<target_id>""") 916 p.set_defaults(func=construct_virtio_pci_scsi_bdev) 917 918 @call_cmd 919 def get_virtio_scsi_devs(args): 920 print_dict(rpc.vhost.get_virtio_scsi_devs(args.client, args)) 921 922 p = subparsers.add_parser('get_virtio_scsi_devs', help='List all Virtio-SCSI devices.') 923 p.set_defaults(func=get_virtio_scsi_devs) 924 925 @call_cmd 926 def remove_virtio_scsi_bdev(args): 927 rpc.vhost.remove_virtio_scsi_bdev(args.client, args) 928 929 p = subparsers.add_parser('remove_virtio_scsi_bdev', help="""Remove a Virtio-SCSI device 930 This will delete all bdevs exposed by this device""") 931 p.add_argument('name', help='Virtio device name. E.g. VirtioUser0') 932 p.set_defaults(func=remove_virtio_scsi_bdev) 933 934 @call_cmd 935 def construct_virtio_user_blk_bdev(args): 936 print_dict(rpc.vhost.construct_virtio_user_blk_bdev(args.client, args)) 937 938 p = subparsers.add_parser('construct_virtio_user_blk_bdev', help='Connect to a virtio user blk device.') 939 p.add_argument('path', help='Path to Virtio BLK socket') 940 p.add_argument('name', help='Name for the bdev') 941 p.add_argument('--vq-count', help='Number of virtual queues to be used.', type=int) 942 p.add_argument('--vq-size', help='Size of each queue', type=int) 943 p.set_defaults(func=construct_virtio_user_blk_bdev) 944 945 @call_cmd 946 def construct_virtio_pci_blk_bdev(args): 947 print_dict(rpc.vhost.construct_virtio_pci_blk_bdev(args.client, args)) 948 949 p = subparsers.add_parser('construct_virtio_pci_blk_bdev', help='Create a Virtio Blk device from a virtio-pci device.') 950 p.add_argument('pci_address', help="""PCI address in domain:bus:device.function format or 951 domain.bus.device.function format""") 952 p.add_argument('name', help='Name for the bdev') 953 p.set_defaults(func=construct_virtio_pci_blk_bdev) 954 955 args = parser.parse_args() 956 957 try: 958 args.client = rpc.client.JSONRPCClient(args.server_addr, args.port, args.verbose, args.timeout) 959 except JSONRPCException as ex: 960 print(ex.message) 961 exit(1) 962 args.func(args) 963