xref: /spdk/scripts/rpc.py (revision 97f3104bc7b8f305409105d19b7e6d6d87d56da5)
1#!/usr/bin/env python
2
3import argparse
4import json
5import socket
6
7try:
8    from shlex import quote
9except ImportError:
10    from pipes import quote
11
12def print_dict(d):
13    print json.dumps(d, indent=2)
14
15def print_array(a):
16    print " ".join((quote(v) for v in a))
17
18parser = argparse.ArgumentParser(description='SPDK RPC command line interface')
19parser.add_argument('-s', dest='server_addr', help='RPC server address', default='/var/tmp/spdk.sock')
20parser.add_argument('-p', dest='port', help='RPC port number (if server_addr is IP address)', default=5260, type=int)
21parser.add_argument('-v', dest='verbose', help='Verbose mode', action='store_true')
22subparsers = parser.add_subparsers(help='RPC methods')
23
24
25def int_arg(arg):
26    return int(arg, 0)
27
28
29def jsonrpc_call(method, params={}):
30    if args.server_addr.startswith('/'):
31        s = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
32        s.connect(args.server_addr)
33    else:
34        s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
35        s.connect((args.server_addr, args.port))
36    req = {}
37    req['jsonrpc'] = '2.0'
38    req['method'] = method
39    req['id'] = 1
40    if (params):
41        req['params'] = params
42    reqstr = json.dumps(req)
43
44    if args.verbose:
45        print("request:")
46        print(json.dumps(req, indent=2))
47
48    s.sendall(reqstr)
49    buf = ''
50    closed = False
51    response = {}
52    while not closed:
53        newdata = s.recv(4096)
54        if (newdata == b''):
55            closed = True
56        buf += newdata
57        try:
58            response = json.loads(buf)
59        except ValueError:
60            continue  # incomplete response; keep buffering
61        break
62    s.close()
63
64    if not response:
65        if method == "kill_instance":
66            exit(0)
67        print "Connection closed with partial response:"
68        print buf
69        exit(1)
70
71    if 'error' in response:
72        print "Got JSON-RPC error response"
73        print "request:"
74        print_dict(json.loads(reqstr))
75        print "response:"
76        print_dict(response['error'])
77        exit(1)
78
79    if args.verbose:
80        print("response:")
81        print(json.dumps(response, indent=2))
82
83    return response['result']
84
85def get_luns(args):
86    print_dict(jsonrpc_call('get_luns'))
87
88p = subparsers.add_parser('get_luns', help='Display active LUNs')
89p.set_defaults(func=get_luns)
90
91
92def get_portal_groups(args):
93    print_dict(jsonrpc_call('get_portal_groups'))
94
95p = subparsers.add_parser('get_portal_groups', help='Display current portal group configuration')
96p.set_defaults(func=get_portal_groups)
97
98
99def get_initiator_groups(args):
100    print_dict(jsonrpc_call('get_initiator_groups'))
101
102p = subparsers.add_parser('get_initiator_groups', help='Display current initiator group configuration')
103p.set_defaults(func=get_initiator_groups)
104
105
106def get_target_nodes(args):
107    print_dict(jsonrpc_call('get_target_nodes'))
108
109p = subparsers.add_parser('get_target_nodes', help='Display target nodes')
110p.set_defaults(func=get_target_nodes)
111
112
113def construct_target_node(args):
114    lun_name_id_dict = dict(u.split(":")
115                            for u in args.lun_name_id_pairs.strip().split(" "))
116    lun_names = lun_name_id_dict.keys()
117    lun_ids = list(map(int, lun_name_id_dict.values()))
118
119    pg_tags = []
120    ig_tags = []
121    for u in args.pg_ig_mappings.strip().split(" "):
122        pg, ig = u.split(":")
123        pg_tags.append(int(pg))
124        ig_tags.append(int(ig))
125
126    params = {
127        'name': args.name,
128        'alias_name': args.alias_name,
129        'pg_tags': pg_tags,
130        'ig_tags': ig_tags,
131        'lun_names': lun_names,
132        'lun_ids': lun_ids,
133        'queue_depth': args.queue_depth,
134        'chap_disabled': args.chap_disabled,
135        'chap_required': args.chap_required,
136        'chap_mutual': args.chap_mutual,
137        'chap_auth_group': args.chap_auth_group,
138    }
139    jsonrpc_call('construct_target_node', params)
140
141p = subparsers.add_parser('construct_target_node', help='Add a target node')
142p.add_argument('name', help='Target node name (ASCII)')
143p.add_argument('alias_name', help='Target node alias name (ASCII)')
144p.add_argument('lun_name_id_pairs', help="""Whitespace-separated list of LUN <name:id> pairs enclosed
145in quotes.  Format:  'lun_name0:id0 lun_name1:id1' etc
146Example: 'Malloc0:0 Malloc1:1 Malloc5:2'
147*** The LUNs must pre-exist ***
148*** LUN0 (id = 0) is required ***
149*** LUN names cannot contain space or colon characters ***""")
150p.add_argument('pg_ig_mappings', help="""List of (Portal_Group_Tag:Initiator_Group_Tag) mappings
151Whitespace separated, quoted, mapping defined with colon
152separated list of "tags" (int > 0)
153Example: '1:1 2:2 2:1'
154*** The Portal/Initiator Groups must be precreated ***""")
155p.add_argument('queue_depth', help='Desired target queue depth', type=int)
156p.add_argument('chap_disabled', help="""CHAP authentication should be disabled for this target node.
157*** Mutually exclusive with chap_required ***""", type=int)
158p.add_argument('chap_required', help="""CHAP authentication should be required for this target node.
159*** Mutually exclusive with chap_disabled ***""", type=int)
160p.add_argument('chap_mutual', help='CHAP authentication should be mutual/bidirectional.', type=int)
161p.add_argument('chap_auth_group', help="""Authentication group ID for this target node.
162*** Authentication group must be precreated ***""", type=int)
163p.set_defaults(func=construct_target_node)
164
165
166def construct_malloc_bdev(args):
167    num_blocks = (args.total_size * 1024 * 1024) / args.block_size
168    params = {'num_blocks': num_blocks, 'block_size': args.block_size}
169    if args.name:
170        params['name'] = args.name
171    print_array(jsonrpc_call('construct_malloc_bdev', params))
172
173p = subparsers.add_parser('construct_malloc_bdev', help='Add a bdev with malloc backend')
174p.add_argument('-b', '--name', help="Name of the bdev")
175p.add_argument('total_size', help='Size of malloc bdev in MB (int > 0)', type=int)
176p.add_argument('block_size', help='Block size for this bdev', type=int)
177p.set_defaults(func=construct_malloc_bdev)
178
179
180def create_pmem_pool(args):
181    num_blocks = (args.total_size * 1024 * 1024) / args.block_size
182    params = {'pmem_file': args.pmem_file,
183              'num_blocks': num_blocks,
184              'block_size': args.block_size}
185    jsonrpc_call('create_pmem_pool', params)
186
187p = subparsers.add_parser('create_pmem_pool', help='Create pmem pool')
188p.add_argument('pmem_file', help='Path to pmemblk pool file')
189p.add_argument('total_size', help='Size of malloc bdev in MB (int > 0)', type=int)
190p.add_argument('block_size', help='Block size for this pmem pool', type=int)
191p.set_defaults(func=create_pmem_pool)
192
193
194def pmem_pool_info(args):
195    params = {'pmem_file': args.pmem_file}
196    print_dict(jsonrpc_call('pmem_pool_info', params))
197
198p = subparsers.add_parser('pmem_pool_info', help='Display pmem pool info and check consistency')
199p.add_argument('pmem_file', help='Path to pmemblk pool file')
200p.set_defaults(func=pmem_pool_info)
201
202
203def delete_pmem_pool(args):
204    params = {'pmem_file': args.pmem_file}
205    jsonrpc_call('delete_pmem_pool', params)
206
207p = subparsers.add_parser('delete_pmem_pool', help='Delete pmem pool')
208p.add_argument('pmem_file', help='Path to pmemblk pool file')
209p.set_defaults(func=delete_pmem_pool)
210
211
212def construct_pmem_bdev(args):
213    params = {'pmem_file': args.pmem_file}
214    if args.name:
215        params['name'] = args.name
216    print_array(jsonrpc_call('construct_pmem_bdev', params))
217
218p = subparsers.add_parser('construct_pmem_bdev', help='Add a bdev with pmem backend')
219p.add_argument('pmem_file', help='Path to pmemblk pool file')
220p.add_argument('-n', '--name', help='Block device name', required=False)
221p.set_defaults(func=construct_pmem_bdev)
222
223def construct_null_bdev(args):
224    num_blocks = (args.total_size * 1024 * 1024) / args.block_size
225    params = {'name': args.name, 'num_blocks': num_blocks, 'block_size': args.block_size}
226    print_array(jsonrpc_call('construct_null_bdev', params))
227
228p = subparsers.add_parser('construct_null_bdev', help='Add a bdev with null backend')
229p.add_argument('name', help='Block device name')
230p.add_argument('total_size', help='Size of null bdev in MB (int > 0)', type=int)
231p.add_argument('block_size', help='Block size for this bdev', type=int)
232p.set_defaults(func=construct_null_bdev)
233
234
235def construct_aio_bdev(args):
236    params = {'name': args.name,
237              'filename': args.filename}
238
239    if args.block_size:
240        params['block_size'] = args.block_size
241
242    print_array(jsonrpc_call('construct_aio_bdev', params))
243
244p = subparsers.add_parser('construct_aio_bdev', help='Add a bdev with aio backend')
245p.add_argument('filename', help='Path to device or file (ex: /dev/sda)')
246p.add_argument('name', help='Block device name')
247p.add_argument('block_size', help='Block size for this bdev', type=int, default=argparse.SUPPRESS)
248p.set_defaults(func=construct_aio_bdev)
249
250def construct_nvme_bdev(args):
251    params = {'name': args.name,
252              'trtype': args.trtype,
253              'traddr': args.traddr}
254
255    if args.adrfam:
256        params['adrfam'] = args.adrfam
257
258    if args.trsvcid:
259        params['trsvcid'] = args.trsvcid
260
261    if args.subnqn:
262        params['subnqn'] = args.subnqn
263
264    jsonrpc_call('construct_nvme_bdev', params)
265
266p = subparsers.add_parser('construct_nvme_bdev', help='Add bdev with nvme backend')
267p.add_argument('-b', '--name', help="Name of the bdev", required=True)
268p.add_argument('-t', '--trtype', help='NVMe-oF target trtype: e.g., rdma, pcie', required=True)
269p.add_argument('-a', '--traddr', help='NVMe-oF target address: e.g., an ip address or BDF', required=True)
270p.add_argument('-f', '--adrfam', help='NVMe-oF target adrfam: e.g., ipv4, ipv6, ib, fc, intra_host')
271p.add_argument('-s', '--trsvcid', help='NVMe-oF target trsvcid: e.g., a port number')
272p.add_argument('-n', '--subnqn', help='NVMe-oF target subnqn')
273p.set_defaults(func=construct_nvme_bdev)
274
275def construct_rbd_bdev(args):
276    params = {
277        'pool_name': args.pool_name,
278        'rbd_name': args.rbd_name,
279        'block_size': args.block_size,
280    }
281    print_array(jsonrpc_call('construct_rbd_bdev', params))
282
283p = subparsers.add_parser('construct_rbd_bdev', help='Add a bdev with ceph rbd backend')
284p.add_argument('pool_name', help='rbd pool name')
285p.add_argument('rbd_name', help='rbd image name')
286p.add_argument('block_size', help='rbd block size', type=int)
287p.set_defaults(func=construct_rbd_bdev)
288
289def construct_error_bdev(args):
290    params = {'base_name': args.base_name}
291    jsonrpc_call('construct_error_bdev', params)
292p = subparsers.add_parser('construct_error_bdev', help='Add bdev with error injection backend')
293p.add_argument('base_name', help='base bdev name')
294p.set_defaults(func=construct_error_bdev)
295
296
297def construct_lvol_store(args):
298    params = {'bdev_name': args.bdev_name, 'lvs_name': args.lvs_name}
299
300    if args.cluster_sz:
301        params['cluster_sz'] = args.cluster_sz
302
303    print_array(jsonrpc_call('construct_lvol_store', params))
304p = subparsers.add_parser('construct_lvol_store', help='Add logical volume store on base bdev')
305p.add_argument('bdev_name', help='base bdev name')
306p.add_argument('lvs_name', help='name for lvol store')
307p.add_argument('-c', '--cluster-sz', help='size of cluster (in bytes)', type=int, required=False)
308p.set_defaults(func=construct_lvol_store)
309
310
311def construct_lvol_bdev(args):
312    num_bytes = (args.size * 1024 * 1024)
313    params = {'lvol_name': args.lvol_name, 'size': num_bytes}
314    if (args.uuid and args.lvs_name) or (not args.uuid and not args.lvs_name):
315        print("You need to specify either uuid or name of lvolstore")
316    else:
317        if args.uuid:
318            params['uuid'] = args.uuid
319        if args.lvs_name:
320            params['lvs_name'] = args.lvs_name
321        print_array(jsonrpc_call('construct_lvol_bdev', params))
322p = subparsers.add_parser('construct_lvol_bdev', help='Add a bdev with an logical volume backend')
323p.add_argument('-u', '--uuid', help='lvol store UUID', required=False)
324p.add_argument('-l', '--lvs_name', help='lvol store name', required=False)
325p.add_argument('lvol_name', help='name for this lvol')
326p.add_argument('size', help='size in MiB for this bdev', type=int)
327p.set_defaults(func=construct_lvol_bdev)
328
329# Logical volume resize feature is disabled, as it is currently work in progress
330#
331# def resize_lvol_bdev(args):
332#     params = {
333#         'name': args.name,
334#         'size': args.size,
335#     }
336#     jsonrpc_call('resize_lvol_bdev', params)
337# p = subparsers.add_parser('resize_lvol_bdev', help='Resize existing lvol bdev')
338# p.add_argument('name', help='lvol bdev name')
339# p.add_argument('size', help='new size in MiB for this bdev', type=int)
340# p.set_defaults(func=resize_lvol_bdev)
341
342
343def destroy_lvol_store(args):
344    params = {}
345    if (args.uuid and args.lvs_name) or (not args.uuid and not args.lvs_name):
346        print("You need to specify either uuid or name of lvolstore")
347    else:
348        if args.uuid:
349            params['uuid'] = args.uuid
350        if args.lvs_name:
351            params['lvs_name'] = args.lvs_name
352        jsonrpc_call('destroy_lvol_store', params)
353p = subparsers.add_parser('destroy_lvol_store', help='Destroy an logical volume store')
354p.add_argument('-u', '--uuid', help='lvol store UUID', required=False)
355p.add_argument('-l', '--lvs_name', help='lvol store name', required=False)
356p.set_defaults(func=destroy_lvol_store)
357
358
359def get_lvol_stores(args):
360    print_dict(jsonrpc_call('get_lvol_stores'))
361
362p = subparsers.add_parser('get_lvol_stores', help='Display current logical volume store list')
363p.set_defaults(func=get_lvol_stores)
364
365
366def set_trace_flag(args):
367    params = {'flag': args.flag}
368    jsonrpc_call('set_trace_flag', params)
369
370p = subparsers.add_parser('set_trace_flag', help='set trace flag')
371p.add_argument('flag', help='trace mask we want to set. (for example "debug").')
372p.set_defaults(func=set_trace_flag)
373
374
375def clear_trace_flag(args):
376    params = {'flag': args.flag}
377    jsonrpc_call('clear_trace_flag', params)
378
379p = subparsers.add_parser('clear_trace_flag', help='clear trace flag')
380p.add_argument('flag', help='trace mask we want to clear. (for example "debug").')
381p.set_defaults(func=clear_trace_flag)
382
383
384def get_trace_flags(args):
385    print_dict(jsonrpc_call('get_trace_flags'))
386
387p = subparsers.add_parser('get_trace_flags', help='get trace flags')
388p.set_defaults(func=get_trace_flags)
389
390
391def add_portal_group(args):
392    # parse out portal list host1:port1 host2:port2
393    portals = []
394    for p in args.portal_list:
395        host_port = p.split(':')
396        portals.append({'host': host_port[0], 'port': host_port[1]})
397
398    params = {'tag': args.tag, 'portals': portals}
399    jsonrpc_call('add_portal_group', params)
400
401p = subparsers.add_parser('add_portal_group', help='Add a portal group')
402p.add_argument('tag', help='Portal group tag (unique, integer > 0)', type=int)
403p.add_argument('portal_list', nargs=argparse.REMAINDER, help="""List of portals in 'host:port' format, separated by whitespace
404Example: '192.168.100.100:3260' '192.168.100.100:3261'""")
405p.set_defaults(func=add_portal_group)
406
407
408def add_initiator_group(args):
409    initiators = []
410    netmasks = []
411    for i in args.initiator_list.strip().split(' '):
412        initiators.append(i)
413    for n in args.netmask_list.strip().split(' '):
414        netmasks.append(n)
415
416    params = {'tag': args.tag, 'initiators': initiators, 'netmasks': netmasks}
417    jsonrpc_call('add_initiator_group', params)
418
419
420p = subparsers.add_parser('add_initiator_group', help='Add an initiator group')
421p.add_argument('tag', help='Initiator group tag (unique, integer > 0)', type=int)
422p.add_argument('initiator_list', help="""Whitespace-separated list of initiator hostnames or IP addresses,
423enclosed in quotes.  Example: 'ALL' or '127.0.0.1 192.168.200.100'""")
424p.add_argument('netmask_list', help="""Whitespace-separated list of initiator netmasks enclosed in quotes.
425Example: '255.255.0.0 255.248.0.0' etc""")
426p.set_defaults(func=add_initiator_group)
427
428
429def delete_target_node(args):
430    params = {'name': args.target_node_name}
431    jsonrpc_call('delete_target_node', params)
432
433p = subparsers.add_parser('delete_target_node', help='Delete a target node')
434p.add_argument('target_node_name', help='Target node name to be deleted. Example: iqn.2016-06.io.spdk:disk1.')
435p.set_defaults(func=delete_target_node)
436
437
438def delete_portal_group(args):
439    params = {'tag': args.tag}
440    jsonrpc_call('delete_portal_group', params)
441
442p = subparsers.add_parser('delete_portal_group', help='Delete a portal group')
443p.add_argument('tag', help='Portal group tag (unique, integer > 0)', type=int)
444p.set_defaults(func=delete_portal_group)
445
446
447def delete_initiator_group(args):
448    params = {'tag': args.tag}
449    jsonrpc_call('delete_initiator_group', params)
450
451p = subparsers.add_parser('delete_initiator_group', help='Delete an initiator group')
452p.add_argument('tag', help='Initiator group tag (unique, integer > 0)', type=int)
453p.set_defaults(func=delete_initiator_group)
454
455
456def get_iscsi_connections(args):
457    print_dict(jsonrpc_call('get_iscsi_connections'))
458
459p = subparsers.add_parser('get_iscsi_connections', help='Display iSCSI connections')
460p.set_defaults(func=get_iscsi_connections)
461
462
463def get_scsi_devices(args):
464    print_dict(jsonrpc_call('get_scsi_devices'))
465
466p = subparsers.add_parser('get_scsi_devices', help='Display SCSI devices')
467p.set_defaults(func=get_scsi_devices)
468
469
470def add_ip_address(args):
471    params = {'ifc_index': args.ifc_index, 'ip_address': args.ip_addr}
472    jsonrpc_call('add_ip_address', params)
473
474p = subparsers.add_parser('add_ip_address', help='Add IP address')
475p.add_argument('ifc_index', help='ifc index of the nic device.', type=int)
476p.add_argument('ip_addr', help='ip address will be added.')
477p.set_defaults(func=add_ip_address)
478
479
480def delete_ip_address(args):
481    params = {'ifc_index': args.ifc_index, 'ip_address': args.ip_addr}
482    jsonrpc_call('delete_ip_address', params)
483
484p = subparsers.add_parser('delete_ip_address', help='Delete IP address')
485p.add_argument('ifc_index', help='ifc index of the nic device.', type=int)
486p.add_argument('ip_addr', help='ip address will be deleted.')
487p.set_defaults(func=delete_ip_address)
488
489
490def get_interfaces(args):
491    print_dict(jsonrpc_call('get_interfaces'))
492
493p = subparsers.add_parser('get_interfaces', help='Display current interface list')
494p.set_defaults(func=get_interfaces)
495
496def apply_firmware(args):
497
498    params = {
499        'filename': args.filename,
500        'bdev_name': args.bdev_name,
501    }
502
503    print_dict(jsonrpc_call('apply_nvme_firmware', params))
504
505p = subparsers.add_parser('apply_firmware', help='Download and commit firmware to NVMe device')
506p.add_argument('filename', help='filename of the firmware to download')
507p.add_argument('bdev_name', help='name of the NVMe device')
508p.set_defaults(func=apply_firmware)
509
510def get_bdevs(args):
511    params = {}
512    if args.name:
513        params['name'] = args.name
514    print_dict(jsonrpc_call('get_bdevs', params))
515
516p = subparsers.add_parser('get_bdevs', help='Display current blockdev list or required blockdev')
517p.add_argument('-b', '--name', help="Name of the Blockdev. Example: Nvme0n1", required=False)
518p.set_defaults(func=get_bdevs)
519
520
521def delete_bdev(args):
522    params = {'name': args.bdev_name}
523    jsonrpc_call('delete_bdev', params)
524
525p = subparsers.add_parser('delete_bdev', help='Delete a blockdev')
526p.add_argument('bdev_name', help='Blockdev name to be deleted. Example: Malloc0.')
527p.set_defaults(func=delete_bdev)
528
529
530def get_nvmf_subsystems(args):
531    print_dict(jsonrpc_call('get_nvmf_subsystems'))
532
533p = subparsers.add_parser('get_nvmf_subsystems', help='Display nvmf subsystems')
534p.set_defaults(func=get_nvmf_subsystems)
535
536def construct_nvmf_subsystem(args):
537    listen_addresses = [dict(u.split(":") for u in a.split(" ")) for a in args.listen.split(",")]
538
539    params = {
540        'core': args.core,
541        'nqn': args.nqn,
542        'listen_addresses': listen_addresses,
543        'serial_number': args.serial_number,
544    }
545
546    if args.hosts:
547        hosts = []
548        for u in args.hosts.strip().split(" "):
549            hosts.append(u)
550        params['hosts'] = hosts
551
552    if args.allow_any_host:
553        params['allow_any_host'] = True
554
555    if args.namespaces:
556        namespaces = []
557        for u in args.namespaces.strip().split(" "):
558            bdev_name = u
559            nsid = 0
560            if ':' in u:
561                (bdev_name, nsid) = u.split(":")
562
563            ns_params = {'bdev_name': bdev_name}
564
565            nsid = int(nsid)
566            if nsid != 0:
567                ns_params['nsid'] = nsid
568
569            namespaces.append(ns_params)
570        params['namespaces'] = namespaces
571
572    jsonrpc_call('construct_nvmf_subsystem', params)
573
574p = subparsers.add_parser('construct_nvmf_subsystem', help='Add a nvmf subsystem')
575p.add_argument("-c", "--core", help='The core Nvmf target run on', type=int, default=-1)
576p.add_argument('nqn', help='Target nqn(ASCII)')
577p.add_argument('listen', help="""comma-separated list of Listen <trtype:transport_name traddr:address trsvcid:port_id> pairs enclosed
578in quotes.  Format:  'trtype:transport0 traddr:traddr0 trsvcid:trsvcid0,trtype:transport1 traddr:traddr1 trsvcid:trsvcid1' etc
579Example: 'trtype:RDMA traddr:192.168.100.8 trsvcid:4420,trtype:RDMA traddr:192.168.100.9 trsvcid:4420'""")
580p.add_argument('hosts', help="""Whitespace-separated list of host nqn list.
581Format:  'nqn1 nqn2' etc
582Example: 'nqn.2016-06.io.spdk:init nqn.2016-07.io.spdk:init'""")
583p.add_argument("-a", "--allow-any-host", action='store_true', help="Allow any host to connect (don't enforce host NQN whitelist)")
584p.add_argument("-s", "--serial_number", help="""
585Format:  'sn' etc
586Example: 'SPDK00000000000001'""", default='0000:00:01.0')
587p.add_argument("-n", "--namespaces", help="""Whitespace-separated list of namespaces
588Format:  'bdev_name1[:nsid1] bdev_name2[:nsid2] bdev_name3[:nsid3]' etc
589Example: '1:Malloc0 2:Malloc1 3:Malloc2'
590*** The devices must pre-exist ***""")
591p.set_defaults(func=construct_nvmf_subsystem)
592
593def delete_nvmf_subsystem(args):
594    params = {'nqn': args.subsystem_nqn}
595    jsonrpc_call('delete_nvmf_subsystem', params)
596
597p = subparsers.add_parser('delete_nvmf_subsystem', help='Delete a nvmf subsystem')
598p.add_argument('subsystem_nqn', help='subsystem nqn to be deleted. Example: nqn.2016-06.io.spdk:cnode1.')
599p.set_defaults(func=delete_nvmf_subsystem)
600
601def bdev_inject_error(args):
602    params = {
603        'name': args.name,
604        'io_type': args.io_type,
605        'error_type': args.error_type,
606        'num': args.num,
607    }
608
609    jsonrpc_call('bdev_inject_error', params)
610
611p = subparsers.add_parser('bdev_inject_error', help='bdev inject error')
612p.add_argument('name', help="""the name of the error injection bdev""")
613p.add_argument('io_type', help="""io_type: 'clear' 'read' 'write' 'unmap' 'flush' 'all'""")
614p.add_argument('error_type', help="""error_type: 'failure' 'pending'""")
615p.add_argument('-n', '--num', help='the number of commands you want to fail', type=int, default=1)
616p.set_defaults(func=bdev_inject_error)
617
618def kill_instance(args):
619    params = {'sig_name': args.sig_name}
620    jsonrpc_call('kill_instance', params)
621
622p = subparsers.add_parser('kill_instance', help='Send signal to instance')
623p.add_argument('sig_name', help='signal will be sent to server.')
624p.set_defaults(func=kill_instance)
625
626def set_vhost_controller_coalescing(args):
627    params = {
628        'ctrlr': args.ctrlr,
629        'delay_base_us': args.delay_base_us,
630        'iops_threshold': args.iops_threshold,
631    }
632    jsonrpc_call('set_vhost_controller_coalescing', params)
633
634p = subparsers.add_parser('set_vhost_controller_coalescing', help='Set vhost controller coalescing')
635p.add_argument('ctrlr', help='controller name')
636p.add_argument('delay_base_us', help='Base delay time', type=int)
637p.add_argument('iops_threshold', help='IOPS threshold when coalescing is enabled', type=int)
638p.set_defaults(func=set_vhost_controller_coalescing)
639
640def construct_vhost_scsi_controller(args):
641    params = {'ctrlr': args.ctrlr}
642
643    if args.cpumask:
644        params['cpumask'] = args.cpumask
645
646    jsonrpc_call('construct_vhost_scsi_controller', params)
647
648p = subparsers.add_parser('construct_vhost_scsi_controller', help='Add new vhost controller')
649p.add_argument('ctrlr', help='controller name')
650p.add_argument('--cpumask', help='cpu mask for this controller')
651p.set_defaults(func=construct_vhost_scsi_controller)
652
653def add_vhost_scsi_lun(args):
654    params = {
655        'ctrlr': args.ctrlr,
656        'scsi_dev_num': args.scsi_dev_num,
657        'lun_name': args.lun_name
658    }
659    jsonrpc_call('add_vhost_scsi_lun', params)
660
661p = subparsers.add_parser('add_vhost_scsi_lun', help='Add lun to vhost controller')
662p.add_argument('ctrlr', help='conntroller name where add lun')
663p.add_argument('scsi_dev_num', help='scsi_dev_num', type=int)
664p.add_argument('lun_name', help='lun name')
665p.set_defaults(func=add_vhost_scsi_lun)
666
667def remove_vhost_scsi_dev(args):
668    params = {
669        'ctrlr': args.ctrlr,
670        'scsi_dev_num': args.scsi_dev_num,
671    }
672    jsonrpc_call('remove_vhost_scsi_dev', params)
673
674p = subparsers.add_parser('remove_vhost_scsi_dev', help='Remove device from vhost controller')
675p.add_argument('ctrlr', help='controller name to remove device from')
676p.add_argument('scsi_dev_num', help='scsi_dev_num', type=int)
677p.set_defaults(func=remove_vhost_scsi_dev)
678
679def construct_vhost_blk_controller(args):
680    params = {
681        'ctrlr': args.ctrlr,
682        'dev_name': args.dev_name,
683    }
684    if args.cpumask:
685        params['cpumask'] = args.cpumask
686    if args.readonly:
687        params['readonly'] = args.readonly
688    jsonrpc_call('construct_vhost_blk_controller', params)
689
690p = subparsers.add_parser('construct_vhost_blk_controller', help='Add a new vhost block controller')
691p.add_argument('ctrlr', help='controller name')
692p.add_argument('dev_name', help='device name')
693p.add_argument('--cpumask', help='cpu mask for this controller')
694p.add_argument("-r", "--readonly", action='store_true', help='Set controller as read-only')
695p.set_defaults(func=construct_vhost_blk_controller)
696
697def get_vhost_controllers(args):
698    print_dict(jsonrpc_call('get_vhost_controllers'))
699
700p = subparsers.add_parser('get_vhost_controllers', help='List vhost controllers')
701p.set_defaults(func=get_vhost_controllers)
702
703def remove_vhost_controller(args):
704    params = {'ctrlr': args.ctrlr}
705    jsonrpc_call('remove_vhost_controller', params)
706
707p = subparsers.add_parser('remove_vhost_controller', help='Remove a vhost controller')
708p.add_argument('ctrlr', help='controller name')
709p.set_defaults(func=remove_vhost_controller)
710
711def construct_virtio_user_scsi_bdev(args):
712    params = {'path': args.path}
713    if args.vq_count:
714        params['vq_count'] = args.vq_count
715    if args.vq_size:
716        params['vq_size'] = args.vq_size
717    print_dict(jsonrpc_call('construct_virtio_user_scsi_bdev', params))
718
719p = subparsers.add_parser('construct_virtio_user_scsi_bdev', help="""Connect to virtio user scsi device.
720This imply scan and add bdevs offered by remote side.
721Result is array of added bdevs.""")
722p.add_argument('path', help='Path to Virtio SCSI socket')
723p.add_argument('-b', '--name', help="""Use this name as base instead of 'VirtioScsiN'
724Base will be used to construct new bdev's found on target by adding 't<TARGET_ID>' sufix.""", required=True)
725p.add_argument('--vq-count', help='Number of virtual queues to be used.', type=int)
726p.add_argument('--vq-size', help='Size of each queue', type=int)
727p.set_defaults(func=construct_virtio_user_scsi_bdev)
728
729def get_rpc_methods(args):
730    print_dict(jsonrpc_call('get_rpc_methods'))
731
732p = subparsers.add_parser('get_rpc_methods', help='Get list of supported RPC methods')
733p.set_defaults(func=get_rpc_methods)
734
735def context_switch_monitor(args):
736    params = {}
737    if args.enable:
738        params['enabled'] = True
739    if args.disable:
740        params['enabled'] = False
741    print_dict(jsonrpc_call('context_switch_monitor', params))
742
743p = subparsers.add_parser('context_switch_monitor', help='Control whether the context switch monitor is enabled')
744p.add_argument('-e', '--enable', action='store_true', help='Enable context switch monitoring')
745p.add_argument('-d', '--disable', action='store_true', help='Disable context switch monitoring')
746p.set_defaults(func=context_switch_monitor)
747
748args = parser.parse_args()
749args.func(args)
750