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