1#!/usr/bin/env python 2 3import argparse 4import rpc 5 6if __name__ == "__main__": 7 parser = argparse.ArgumentParser( 8 description='SPDK RPC command line interface') 9 parser.add_argument('-s', dest='server_addr', 10 help='RPC server address', default='/var/tmp/spdk.sock') 11 parser.add_argument('-p', dest='port', 12 help='RPC port number (if server_addr is IP address)', 13 default=5260, type=int) 14 parser.add_argument('-t', dest='timeout', 15 help='Timout as a floating point number expressed in seconds waiting for reponse. Default: 60.0', 16 default=60.0, type=float) 17 parser.add_argument('-v', dest='verbose', 18 help='Verbose mode', action='store_true') 19 subparsers = parser.add_subparsers(help='RPC methods') 20 21 p = subparsers.add_parser('get_rpc_methods', help='Get list of supported RPC methods') 22 p.set_defaults(func=rpc.get_rpc_methods) 23 24 p = subparsers.add_parser('save_config', help="""Write current (live) configuration of SPDK subsystems and targets. 25 If no filename is given write configuration to stdout.""") 26 p.add_argument('-f', '--filename', help="""File where to save JSON configuration to.""") 27 p.add_argument('-i', '--indent', help="""Indent level. Value less than 0 mean compact mode. If filename is not given default 28 indent level is 2. If writing to file of filename is '-' then default is compact mode.""", type=int, default=2) 29 p.set_defaults(func=rpc.save_config) 30 31 p = subparsers.add_parser('load_config', help="""Configure SPDK subsystems and tagets using JSON RPC. If no file is 32 provided or file is '-' read configuration from stdin.""") 33 p.add_argument('--filename', help="""JSON Configuration file.""") 34 p.set_defaults(func=rpc.load_config) 35 36 # app 37 p = subparsers.add_parser('kill_instance', help='Send signal to instance') 38 p.add_argument('sig_name', help='signal will be sent to server.') 39 p.set_defaults(func=rpc.app.kill_instance) 40 41 p = subparsers.add_parser('context_switch_monitor', help='Control whether the context switch monitor is enabled') 42 p.add_argument('-e', '--enable', action='store_true', help='Enable context switch monitoring') 43 p.add_argument('-d', '--disable', action='store_true', help='Disable context switch monitoring') 44 p.set_defaults(func=rpc.app.context_switch_monitor) 45 46 # bdev 47 p = subparsers.add_parser('construct_malloc_bdev', 48 help='Add a bdev with malloc backend') 49 p.add_argument('-b', '--name', help="Name of the bdev") 50 p.add_argument('-u', '--uuid', help="UUID of the bdev") 51 p.add_argument( 52 'total_size', help='Size of malloc bdev in MB (int > 0)', type=int) 53 p.add_argument('block_size', help='Block size for this bdev', type=int) 54 p.set_defaults(func=rpc.bdev.construct_malloc_bdev) 55 56 p = subparsers.add_parser('construct_null_bdev', 57 help='Add a bdev with null backend') 58 p.add_argument('name', help='Block device name') 59 p.add_argument('-u', '--uuid', help='UUID of the bdev') 60 p.add_argument( 61 'total_size', help='Size of null bdev in MB (int > 0)', type=int) 62 p.add_argument('block_size', help='Block size for this bdev', type=int) 63 p.set_defaults(func=rpc.bdev.construct_null_bdev) 64 65 p = subparsers.add_parser('construct_aio_bdev', 66 help='Add a bdev with aio backend') 67 p.add_argument('filename', help='Path to device or file (ex: /dev/sda)') 68 p.add_argument('name', help='Block device name') 69 p.add_argument('block_size', help='Block size for this bdev', type=int, default=argparse.SUPPRESS) 70 p.set_defaults(func=rpc.bdev.construct_aio_bdev) 71 72 p = subparsers.add_parser('construct_nvme_bdev', 73 help='Add bdev with nvme backend') 74 p.add_argument('-b', '--name', help="Name of the bdev", required=True) 75 p.add_argument('-t', '--trtype', 76 help='NVMe-oF target trtype: e.g., rdma, pcie', required=True) 77 p.add_argument('-a', '--traddr', 78 help='NVMe-oF target address: e.g., an ip address or BDF', required=True) 79 p.add_argument('-f', '--adrfam', 80 help='NVMe-oF target adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 81 p.add_argument('-s', '--trsvcid', 82 help='NVMe-oF target trsvcid: e.g., a port number') 83 p.add_argument('-n', '--subnqn', help='NVMe-oF target subnqn') 84 p.set_defaults(func=rpc.bdev.construct_nvme_bdev) 85 86 p = subparsers.add_parser('construct_rbd_bdev', 87 help='Add a bdev with ceph rbd backend') 88 p.add_argument('pool_name', help='rbd pool name') 89 p.add_argument('rbd_name', help='rbd image name') 90 p.add_argument('block_size', help='rbd block size', type=int) 91 p.set_defaults(func=rpc.bdev.construct_rbd_bdev) 92 93 p = subparsers.add_parser('construct_error_bdev', 94 help='Add bdev with error injection backend') 95 p.add_argument('base_name', help='base bdev name') 96 p.set_defaults(func=rpc.bdev.construct_error_bdev) 97 98 p = subparsers.add_parser('construct_pmem_bdev', help='Add a bdev with pmem backend') 99 p.add_argument('pmem_file', help='Path to pmemblk pool file') 100 p.add_argument('-n', '--name', help='Block device name', required=True) 101 p.set_defaults(func=rpc.bdev.construct_pmem_bdev) 102 103 p = subparsers.add_parser( 104 'get_bdevs', help='Display current blockdev list or required blockdev') 105 p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1", required=False) 106 p.set_defaults(func=rpc.bdev.get_bdevs) 107 108 p = subparsers.add_parser( 109 'get_bdevs_config', help='Display current (live) blockdev configuration list or required blockdev') 110 p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1", required=False) 111 p.set_defaults(func=rpc.bdev.get_bdevs_config) 112 113 p = subparsers.add_parser('delete_bdev', help='Delete a blockdev') 114 p.add_argument( 115 'bdev_name', help='Blockdev name to be deleted. Example: Malloc0.') 116 p.set_defaults(func=rpc.bdev.delete_bdev) 117 118 p = subparsers.add_parser('bdev_inject_error', help='bdev inject error') 119 p.add_argument('name', help="""the name of the error injection bdev""") 120 p.add_argument('io_type', help="""io_type: 'clear' 'read' 'write' 'unmap' 'flush' 'all'""") 121 p.add_argument('error_type', help="""error_type: 'failure' 'pending'""") 122 p.add_argument( 123 '-n', '--num', help='the number of commands you want to fail', type=int, default=1) 124 p.set_defaults(func=rpc.bdev.bdev_inject_error) 125 126 p = subparsers.add_parser('apply_firmware', help='Download and commit firmware to NVMe device') 127 p.add_argument('filename', help='filename of the firmware to download') 128 p.add_argument('bdev_name', help='name of the NVMe device') 129 p.set_defaults(func=rpc.bdev.apply_firmware) 130 131 # iSCSI 132 p = subparsers.add_parser( 133 'get_portal_groups', help='Display current portal group configuration') 134 p.set_defaults(func=rpc.iscsi.get_portal_groups) 135 136 p = subparsers.add_parser('get_initiator_groups', 137 help='Display current initiator group configuration') 138 p.set_defaults(func=rpc.iscsi.get_initiator_groups) 139 140 p = subparsers.add_parser('get_target_nodes', help='Display target nodes') 141 p.set_defaults(func=rpc.iscsi.get_target_nodes) 142 143 p = subparsers.add_parser('construct_target_node', 144 help='Add a target node') 145 p.add_argument('name', help='Target node name (ASCII)') 146 p.add_argument('alias_name', help='Target node alias name (ASCII)') 147 p.add_argument('bdev_name_id_pairs', help="""Whitespace-separated list of <bdev name:LUN ID> pairs enclosed 148 in quotes. Format: 'bdev_name0:id0 bdev_name1:id1' etc 149 Example: 'Malloc0:0 Malloc1:1 Malloc5:2' 150 *** The bdevs must pre-exist *** 151 *** LUN0 (id = 0) is required *** 152 *** bdevs names cannot contain space or colon characters ***""") 153 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings 154 Whitespace separated, quoted, mapping defined with colon 155 separated list of "tags" (int > 0) 156 Example: '1:1 2:2 2:1' 157 *** The Portal/Initiator Groups must be precreated ***""") 158 p.add_argument('queue_depth', help='Desired target queue depth', type=int) 159 p.add_argument('-g', '--chap-group', help="""Authentication group ID for this target node. 160 *** Authentication group must be precreated ***""", type=int, default=0) 161 p.add_argument('-d', '--disable-chap', help="""CHAP authentication should be disabled for this target node. 162 *** Mutually exclusive with --require-chap ***""", action='store_true') 163 p.add_argument('-r', '--require-chap', help="""CHAP authentication should be required for this target node. 164 *** Mutually exclusive with --disable-chap ***""", action='store_true') 165 p.add_argument( 166 '-m', '--mutual-chap', help='CHAP authentication should be mutual/bidirectional.', action='store_true') 167 p.add_argument('-H', '--header-digest', 168 help='Header Digest should be required for this target node.', action='store_true') 169 p.add_argument('-D', '--data-digest', 170 help='Data Digest should be required for this target node.', action='store_true') 171 p.set_defaults(func=rpc.iscsi.construct_target_node) 172 173 p = subparsers.add_parser('target_node_add_lun', help='Add LUN to the target node') 174 p.add_argument('name', help='Target node name (ASCII)') 175 p.add_argument('bdev_name', help="""bdev name enclosed in quotes. 176 *** bdev name cannot contain space or colon characters ***""") 177 p.add_argument('-i', dest='lun_id', help="""LUN ID (integer >= 0) 178 *** If LUN ID is omitted or -1, the lowest free one is assigned ***""", type=int, required=False) 179 p.set_defaults(func=rpc.iscsi.target_node_add_lun) 180 181 p = subparsers.add_parser('add_pg_ig_maps', help='Add PG-IG maps to the target node') 182 p.add_argument('name', help='Target node name (ASCII)') 183 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings 184 Whitespace separated, quoted, mapping defined with colon 185 separated list of "tags" (int > 0) 186 Example: '1:1 2:2 2:1' 187 *** The Portal/Initiator Groups must be precreated ***""") 188 p.set_defaults(func=rpc.iscsi.add_pg_ig_maps) 189 190 p = subparsers.add_parser('delete_pg_ig_maps', help='Delete PG-IG maps from the target node') 191 p.add_argument('name', help='Target node name (ASCII)') 192 p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings 193 Whitespace separated, quoted, mapping defined with colon 194 separated list of "tags" (int > 0) 195 Example: '1:1 2:2 2:1' 196 *** The Portal/Initiator Groups must be precreated ***""") 197 p.set_defaults(func=rpc.iscsi.delete_pg_ig_maps) 198 199 p = subparsers.add_parser('add_portal_group', help='Add a portal group') 200 p.add_argument( 201 'tag', help='Portal group tag (unique, integer > 0)', type=int) 202 p.add_argument('portal_list', nargs=argparse.REMAINDER, help="""List of portals in 'host:port@cpumask' format, separated by whitespace 203 (cpumask is optional and can be skipped) 204 Example: '192.168.100.100:3260' '192.168.100.100:3261' '192.168.100.100:3262@0x1""") 205 p.set_defaults(func=rpc.iscsi.add_portal_group) 206 207 p = subparsers.add_parser('add_initiator_group', 208 help='Add an initiator group') 209 p.add_argument( 210 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 211 p.add_argument('initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses, 212 enclosed in quotes. Example: 'ANY' or '127.0.0.1 192.168.200.100'""") 213 p.add_argument('netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes. 214 Example: '255.255.0.0 255.248.0.0' etc""") 215 p.set_defaults(func=rpc.iscsi.add_initiator_group) 216 217 p = subparsers.add_parser('add_initiators_to_initiator_group', 218 help='Add initiators to an existing initiator group') 219 p.add_argument( 220 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 221 p.add_argument('-n', dest='initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses, 222 enclosed in quotes. This parameter can be omitted. Example: 'ANY' or '127.0.0.1 192.168.200.100'""", required=False) 223 p.add_argument('-m', dest='netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes. 224 This parameter can be omitted. Example: '255.255.0.0 255.248.0.0' etc""", required=False) 225 p.set_defaults(func=rpc.iscsi.add_initiators_to_initiator_group) 226 227 p = subparsers.add_parser('delete_initiators_from_initiator_group', 228 help='Delete initiators from an existing initiator group') 229 p.add_argument( 230 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 231 p.add_argument('-n', dest='initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses, 232 enclosed in quotes. This parameter can be omitted. Example: 'ANY' or '127.0.0.1 192.168.200.100'""", required=False) 233 p.add_argument('-m', dest='netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes. 234 This parameter can be omitted. Example: '255.255.0.0 255.248.0.0' etc""", required=False) 235 p.set_defaults(func=rpc.iscsi.delete_initiators_from_initiator_group) 236 237 p = subparsers.add_parser('delete_target_node', 238 help='Delete a target node') 239 p.add_argument('target_node_name', 240 help='Target node name to be deleted. Example: iqn.2016-06.io.spdk:disk1.') 241 p.set_defaults(func=rpc.iscsi.delete_target_node) 242 243 p = subparsers.add_parser('delete_portal_group', 244 help='Delete a portal group') 245 p.add_argument( 246 'tag', help='Portal group tag (unique, integer > 0)', type=int) 247 p.set_defaults(func=rpc.iscsi.delete_portal_group) 248 249 p = subparsers.add_parser('delete_initiator_group', 250 help='Delete an initiator group') 251 p.add_argument( 252 'tag', help='Initiator group tag (unique, integer > 0)', type=int) 253 p.set_defaults(func=rpc.iscsi.delete_initiator_group) 254 255 p = subparsers.add_parser('get_iscsi_connections', 256 help='Display iSCSI connections') 257 p.set_defaults(func=rpc.iscsi.get_iscsi_connections) 258 259 p = subparsers.add_parser('get_iscsi_global_params', help='Display iSCSI global parameters') 260 p.set_defaults(func=rpc.iscsi.get_iscsi_global_params) 261 262 p = subparsers.add_parser('get_scsi_devices', help='Display SCSI devices') 263 p.set_defaults(func=rpc.iscsi.get_scsi_devices) 264 265 # log 266 p = subparsers.add_parser('set_trace_flag', help='set trace flag') 267 p.add_argument( 268 'flag', help='trace mask we want to set. (for example "debug").') 269 p.set_defaults(func=rpc.log.set_trace_flag) 270 271 p = subparsers.add_parser('clear_trace_flag', help='clear trace flag') 272 p.add_argument( 273 'flag', help='trace mask we want to clear. (for example "debug").') 274 p.set_defaults(func=rpc.log.clear_trace_flag) 275 276 p = subparsers.add_parser('get_trace_flags', help='get trace flags') 277 p.set_defaults(func=rpc.log.get_trace_flags) 278 279 p = subparsers.add_parser('set_log_level', help='set log level') 280 p.add_argument('level', help='log level we want to set. (for example "DEBUG").') 281 p.set_defaults(func=rpc.log.set_log_level) 282 283 p = subparsers.add_parser('get_log_level', help='get log level') 284 p.set_defaults(func=rpc.log.get_log_level) 285 286 p = subparsers.add_parser('set_log_print_level', help='set log print level') 287 p.add_argument('level', help='log print level we want to set. (for example "DEBUG").') 288 p.set_defaults(func=rpc.log.set_log_print_level) 289 290 p = subparsers.add_parser('get_log_print_level', help='get log print level') 291 p.set_defaults(func=rpc.log.get_log_print_level) 292 293 # lvol 294 p = subparsers.add_parser('construct_lvol_store', help='Add logical volume store on base bdev') 295 p.add_argument('bdev_name', help='base bdev name') 296 p.add_argument('lvs_name', help='name for lvol store') 297 p.add_argument('-c', '--cluster-sz', help='size of cluster (in bytes)', type=int, required=False) 298 p.set_defaults(func=rpc.lvol.construct_lvol_store) 299 300 p = subparsers.add_parser('rename_lvol_store', help='Change logical volume store name') 301 p.add_argument('old_name', help='old name') 302 p.add_argument('new_name', help='new name') 303 p.set_defaults(func=rpc.lvol.rename_lvol_store) 304 305 p = subparsers.add_parser('construct_lvol_bdev', help='Add a bdev with an logical volume backend') 306 p.add_argument('-u', '--uuid', help='lvol store UUID', required=False) 307 p.add_argument('-l', '--lvs_name', help='lvol store name', required=False) 308 p.add_argument('-t', '--thin-provision', action='store_true', help='create lvol bdev as thin provisioned') 309 p.add_argument('lvol_name', help='name for this lvol') 310 p.add_argument('size', help='size in MiB for this bdev', type=int) 311 p.set_defaults(func=rpc.lvol.construct_lvol_bdev) 312 313 p = subparsers.add_parser('rename_lvol_bdev', help='Change lvol bdev name') 314 p.add_argument('old_name', help='lvol bdev name') 315 p.add_argument('new_name', help='new lvol name') 316 p.set_defaults(func=rpc.lvol.rename_lvol_bdev) 317 318 # Logical volume resize feature is disabled, as it is currently work in progress 319 # p = subparsers.add_parser('resize_lvol_bdev', help='Resize existing lvol bdev') 320 # p.add_argument('name', help='lvol bdev name') 321 # p.add_argument('size', help='new size in MiB for this bdev', type=int) 322 # p.set_defaults(func=rpc.lvol.resize_lvol_bdev) 323 324 p = subparsers.add_parser('destroy_lvol_store', help='Destroy an logical volume store') 325 p.add_argument('-u', '--uuid', help='lvol store UUID', required=False) 326 p.add_argument('-l', '--lvs_name', help='lvol store name', required=False) 327 p.set_defaults(func=rpc.lvol.destroy_lvol_store) 328 329 p = subparsers.add_parser('get_lvol_stores', help='Display current logical volume store list') 330 p.add_argument('-u', '--uuid', help='lvol store UUID', required=False) 331 p.add_argument('-l', '--lvs_name', help='lvol store name', required=False) 332 p.set_defaults(func=rpc.lvol.get_lvol_stores) 333 334 # nbd 335 p = subparsers.add_parser('start_nbd_disk', help='Export a bdev as a nbd disk') 336 p.add_argument('bdev_name', help='Blockdev name to be exported. Example: Malloc0.') 337 p.add_argument('nbd_device', help='Nbd device name to be assigned. Example: /dev/nbd0.') 338 p.set_defaults(func=rpc.nbd.start_nbd_disk) 339 340 p = subparsers.add_parser('stop_nbd_disk', help='Stop a nbd disk') 341 p.add_argument('nbd_device', help='Nbd device name to be stopped. Example: /dev/nbd0.') 342 p.set_defaults(func=rpc.nbd.stop_nbd_disk) 343 344 p = subparsers.add_parser('get_nbd_disks', help='Display full or specified nbd device list') 345 p.add_argument('-n', '--nbd_device', help="Path of the nbd device. Example: /dev/nbd0", required=False) 346 p.set_defaults(func=rpc.nbd.get_nbd_disks) 347 348 # net 349 p = subparsers.add_parser('add_ip_address', help='Add IP address') 350 p.add_argument('ifc_index', help='ifc index of the nic device.', type=int) 351 p.add_argument('ip_addr', help='ip address will be added.') 352 p.set_defaults(func=rpc.net.add_ip_address) 353 354 p = subparsers.add_parser('delete_ip_address', help='Delete IP address') 355 p.add_argument('ifc_index', help='ifc index of the nic device.', type=int) 356 p.add_argument('ip_addr', help='ip address will be deleted.') 357 p.set_defaults(func=rpc.net.delete_ip_address) 358 359 p = subparsers.add_parser( 360 'get_interfaces', help='Display current interface list') 361 p.set_defaults(func=rpc.net.get_interfaces) 362 363 # NVMe-oF 364 p = subparsers.add_parser('get_nvmf_subsystems', 365 help='Display nvmf subsystems') 366 p.set_defaults(func=rpc.nvmf.get_nvmf_subsystems) 367 368 p = subparsers.add_parser('construct_nvmf_subsystem', help='Add a nvmf subsystem') 369 p.add_argument('nqn', help='Target nqn(ASCII)') 370 p.add_argument('listen', help="""comma-separated list of Listen <trtype:transport_name traddr:address trsvcid:port_id> pairs enclosed 371 in quotes. Format: 'trtype:transport0 traddr:traddr0 trsvcid:trsvcid0,trtype:transport1 traddr:traddr1 trsvcid:trsvcid1' etc 372 Example: 'trtype:RDMA traddr:192.168.100.8 trsvcid:4420,trtype:RDMA traddr:192.168.100.9 trsvcid:4420'""") 373 p.add_argument('hosts', help="""Whitespace-separated list of host nqn list. 374 Format: 'nqn1 nqn2' etc 375 Example: 'nqn.2016-06.io.spdk:init nqn.2016-07.io.spdk:init'""") 376 p.add_argument("-a", "--allow-any-host", action='store_true', help="Allow any host to connect (don't enforce host NQN whitelist)") 377 p.add_argument("-s", "--serial_number", help=""" 378 Format: 'sn' etc 379 Example: 'SPDK00000000000001'""", default='0000:00:01.0') 380 p.add_argument("-n", "--namespaces", help="""Whitespace-separated list of namespaces 381 Format: 'bdev_name1[:nsid1] bdev_name2[:nsid2] bdev_name3[:nsid3]' etc 382 Example: '1:Malloc0 2:Malloc1 3:Malloc2' 383 *** The devices must pre-exist ***""") 384 p.set_defaults(func=rpc.nvmf.construct_nvmf_subsystem) 385 386 p = subparsers.add_parser('delete_nvmf_subsystem', 387 help='Delete a nvmf subsystem') 388 p.add_argument('subsystem_nqn', 389 help='subsystem nqn to be deleted. Example: nqn.2016-06.io.spdk:cnode1.') 390 p.set_defaults(func=rpc.nvmf.delete_nvmf_subsystem) 391 392 p = subparsers.add_parser('nvmf_subsystem_add_listener', help='Add a listener to an NVMe-oF subsystem') 393 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 394 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True) 395 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True) 396 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 397 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number') 398 p.set_defaults(func=rpc.nvmf.nvmf_subsystem_add_listener) 399 400 p = subparsers.add_parser('nvmf_subsystem_remove_listener', help='Remove a listener from an NVMe-oF subsystem') 401 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 402 p.add_argument('-t', '--trtype', help='NVMe-oF transport type: e.g., rdma', required=True) 403 p.add_argument('-a', '--traddr', help='NVMe-oF transport address: e.g., an ip address', required=True) 404 p.add_argument('-f', '--adrfam', help='NVMe-oF transport adrfam: e.g., ipv4, ipv6, ib, fc, intra_host') 405 p.add_argument('-s', '--trsvcid', help='NVMe-oF transport service id: e.g., a port number') 406 p.set_defaults(func=rpc.nvmf.nvmf_subsystem_remove_listener) 407 408 p = subparsers.add_parser('nvmf_subsystem_add_ns', help='Add a namespace to an NVMe-oF subsystem') 409 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 410 p.add_argument('bdev_name', help='The name of the bdev that will back this namespace') 411 p.add_argument('-n', '--nsid', help='The requested NSID (optional)', type=int) 412 p.add_argument('-g', '--nguid', help='Namespace globally unique identifier (optional)') 413 p.add_argument('-e', '--eui64', help='Namespace EUI-64 identifier (optional)') 414 p.set_defaults(func=rpc.nvmf.nvmf_subsystem_add_ns) 415 416 p = subparsers.add_parser('nvmf_subsystem_remove_ns', help='Remove a namespace to an NVMe-oF subsystem') 417 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 418 p.add_argument('nsid', help='The requested NSID', type=int) 419 p.set_defaults(func=rpc.nvmf.nvmf_subsystem_remove_ns) 420 421 p = subparsers.add_parser('nvmf_subsystem_add_host', help='Add a host to an NVMe-oF subsystem') 422 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 423 p.add_argument('host', help='Host NQN to allow') 424 p.set_defaults(func=rpc.nvmf.nvmf_subsystem_add_host) 425 426 p = subparsers.add_parser('nvmf_subsystem_remove_host', help='Remove a host from an NVMe-oF subsystem') 427 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 428 p.add_argument('host', help='Host NQN to remove') 429 p.set_defaults(func=rpc.nvmf.nvmf_subsystem_remove_host) 430 431 p = subparsers.add_parser('nvmf_subsystem_allow_any_host', help='Allow any host to connect to the subsystem') 432 p.add_argument('nqn', help='NVMe-oF subsystem NQN') 433 p.add_argument('-e', '--enable', action='store_true', help='Enable allowing any host') 434 p.add_argument('-d', '--disable', action='store_true', help='Disable allowing any host') 435 p.set_defaults(func=rpc.nvmf.nvmf_subsystem_allow_any_host) 436 437 # pmem 438 p = subparsers.add_parser('create_pmem_pool', help='Create pmem pool') 439 p.add_argument('pmem_file', help='Path to pmemblk pool file') 440 p.add_argument('total_size', help='Size of malloc bdev in MB (int > 0)', type=int) 441 p.add_argument('block_size', help='Block size for this pmem pool', type=int) 442 p.set_defaults(func=rpc.pmem.create_pmem_pool) 443 444 p = subparsers.add_parser('pmem_pool_info', help='Display pmem pool info and check consistency') 445 p.add_argument('pmem_file', help='Path to pmemblk pool file') 446 p.set_defaults(func=rpc.pmem.pmem_pool_info) 447 448 p = subparsers.add_parser('delete_pmem_pool', help='Delete pmem pool') 449 p.add_argument('pmem_file', help='Path to pmemblk pool file') 450 p.set_defaults(func=rpc.pmem.delete_pmem_pool) 451 452 # subsystem 453 p = subparsers.add_parser('get_subsystems', help=""""Print subsystems array in initialization order. Each subsystem 454 entry contain (unsorted) array of subsystems it depends on.""") 455 p.set_defaults(func=rpc.subsystem.get_subsystems) 456 457 p = subparsers.add_parser('get_subsystem_config', help=""""Print subsystem configuration""") 458 p.add_argument('name', help='Name of subsystem to query') 459 p.set_defaults(func=rpc.subsystem.get_subsystem_config) 460 461 # vhost 462 p = subparsers.add_parser('set_vhost_controller_coalescing', help='Set vhost controller coalescing') 463 p.add_argument('ctrlr', help='controller name') 464 p.add_argument('delay_base_us', help='Base delay time', type=int) 465 p.add_argument('iops_threshold', help='IOPS threshold when coalescing is enabled', type=int) 466 p.set_defaults(func=rpc.vhost.set_vhost_controller_coalescing) 467 468 p = subparsers.add_parser( 469 'construct_vhost_scsi_controller', help='Add new vhost controller') 470 p.add_argument('ctrlr', help='controller name') 471 p.add_argument('--cpumask', help='cpu mask for this controller') 472 p.set_defaults(func=rpc.vhost.construct_vhost_scsi_controller) 473 474 p = subparsers.add_parser('add_vhost_scsi_lun', 475 help='Add lun to vhost controller') 476 p.add_argument('ctrlr', help='conntroller name where add lun') 477 p.add_argument('scsi_target_num', help='scsi_target_num', type=int) 478 p.add_argument('bdev_name', help='bdev name') 479 p.set_defaults(func=rpc.vhost.add_vhost_scsi_lun) 480 481 p = subparsers.add_parser('remove_vhost_scsi_target', help='Remove target from vhost controller') 482 p.add_argument('ctrlr', help='controller name to remove target from') 483 p.add_argument('scsi_target_num', help='scsi_target_num', type=int) 484 p.set_defaults(func=rpc.vhost.remove_vhost_scsi_target) 485 486 p = subparsers.add_parser('construct_vhost_blk_controller', help='Add a new vhost block controller') 487 p.add_argument('ctrlr', help='controller name') 488 p.add_argument('dev_name', help='device name') 489 p.add_argument('--cpumask', help='cpu mask for this controller') 490 p.add_argument("-r", "--readonly", action='store_true', help='Set controller as read-only') 491 p.set_defaults(func=rpc.vhost.construct_vhost_blk_controller) 492 493 p = subparsers.add_parser('get_vhost_controllers', help='List vhost controllers') 494 p.set_defaults(func=rpc.vhost.get_vhost_controllers) 495 496 p = subparsers.add_parser('remove_vhost_controller', help='Remove a vhost controller') 497 p.add_argument('ctrlr', help='controller name') 498 p.set_defaults(func=rpc.vhost.remove_vhost_controller) 499 500 p = subparsers.add_parser('construct_virtio_user_scsi_bdev', help="""Connect to virtio user scsi device. 501 This imply scan and add bdevs offered by remote side. 502 Result is array of added bdevs.""") 503 p.add_argument('path', help='Path to Virtio SCSI socket') 504 p.add_argument('name', help="""Use this name as base instead of 'VirtioScsiN' 505 Base will be used to construct new bdev's found on target by adding 't<TARGET_ID>' sufix.""") 506 p.add_argument('--vq-count', help='Number of virtual queues to be used.', type=int) 507 p.add_argument('--vq-size', help='Size of each queue', type=int) 508 p.set_defaults(func=rpc.vhost.construct_virtio_user_scsi_bdev) 509 510 p = subparsers.add_parser('construct_virtio_pci_scsi_bdev', help="""Create a Virtio 511 SCSI device from a virtio-pci device.""") 512 p.add_argument('pci_address', help="""PCI address in domain:bus:device.function format or 513 domain.bus.device.function format""") 514 p.add_argument('name', help="""Name for the virtio device. 515 It will be inhereted by all created bdevs, which are named n the following format: <name>t<target_id>""") 516 p.set_defaults(func=rpc.vhost.construct_virtio_pci_scsi_bdev) 517 518 p = subparsers.add_parser('remove_virtio_scsi_bdev', help="""Remove a Virtio-SCSI device 519 This will delete all bdevs exposed by this device""") 520 p.add_argument('name', help='Virtio device name. E.g. VirtioUser0') 521 p.set_defaults(func=rpc.vhost.remove_virtio_scsi_bdev) 522 523 p = subparsers.add_parser('construct_virtio_user_blk_bdev', help='Connect to a virtio user blk device.') 524 p.add_argument('path', help='Path to Virtio BLK socket') 525 p.add_argument('name', help='Name for the bdev') 526 p.add_argument('--vq-count', help='Number of virtual queues to be used.', type=int) 527 p.add_argument('--vq-size', help='Size of each queue', type=int) 528 p.set_defaults(func=rpc.vhost.construct_virtio_user_blk_bdev) 529 530 p = subparsers.add_parser('construct_virtio_pci_scsi_bdev', help='Create a Virtio Blk device from a virtio-pci device.') 531 p.add_argument('pci_address', help="""PCI address in domain:bus:device.function format or 532 domain.bus.device.function format""") 533 p.add_argument('name', help='Name for the bdev') 534 p.set_defaults(func=rpc.vhost.construct_virtio_pci_blk_bdev) 535 536 args = parser.parse_args() 537 538 args.client = rpc.client.JSONRPCClient(args.server_addr, args.port, args.verbose, args.timeout) 539 args.func(args) 540