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