]> Git Repo - qemu.git/blob - qapi/net.json
target/m68k: use gdb_get_reg helpers
[qemu.git] / qapi / net.json
1 # -*- Mode: Python -*-
2 #
3
4 ##
5 # = Net devices
6 ##
7
8 { 'include': 'common.json' }
9
10 ##
11 # @set_link:
12 #
13 # Sets the link status of a virtual network adapter.
14 #
15 # @name: the device name of the virtual network adapter
16 #
17 # @up: true to set the link status to be up
18 #
19 # Returns: Nothing on success
20 #          If @name is not a valid network device, DeviceNotFound
21 #
22 # Since: 0.14.0
23 #
24 # Notes: Not all network adapters support setting link status.  This command
25 #        will succeed even if the network adapter does not support link status
26 #        notification.
27 #
28 # Example:
29 #
30 # -> { "execute": "set_link",
31 #      "arguments": { "name": "e1000.0", "up": false } }
32 # <- { "return": {} }
33 #
34 ##
35 { 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
36
37 ##
38 # @netdev_add:
39 #
40 # Add a network backend.
41 #
42 # @type: the type of network backend. Possible values are listed in
43 #        NetClientDriver (excluding 'none' and 'nic')
44 #
45 # @id: the name of the new network backend
46 #
47 # Additional arguments depend on the type.
48 #
49 # TODO: This command effectively bypasses QAPI completely due to its
50 #       "additional arguments" business.  It shouldn't have been added to
51 #       the schema in this form.  It should be qapified properly, or
52 #       replaced by a properly qapified command.
53 #
54 # Since: 0.14.0
55 #
56 # Returns: Nothing on success
57 #          If @type is not a valid network backend, DeviceNotFound
58 #
59 # Example:
60 #
61 # -> { "execute": "netdev_add",
62 #      "arguments": { "type": "user", "id": "netdev1",
63 #                     "dnssearch": "example.org" } }
64 # <- { "return": {} }
65 #
66 ##
67 { 'command': 'netdev_add',
68   'data': {'type': 'str', 'id': 'str'},
69   'gen': false }                # so we can get the additional arguments
70
71 ##
72 # @netdev_del:
73 #
74 # Remove a network backend.
75 #
76 # @id: the name of the network backend to remove
77 #
78 # Returns: Nothing on success
79 #          If @id is not a valid network backend, DeviceNotFound
80 #
81 # Since: 0.14.0
82 #
83 # Example:
84 #
85 # -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
86 # <- { "return": {} }
87 #
88 ##
89 { 'command': 'netdev_del', 'data': {'id': 'str'} }
90
91 ##
92 # @NetLegacyNicOptions:
93 #
94 # Create a new Network Interface Card.
95 #
96 # @netdev: id of -netdev to connect to
97 #
98 # @macaddr: MAC address
99 #
100 # @model: device model (e1000, rtl8139, virtio etc.)
101 #
102 # @addr: PCI device address
103 #
104 # @vectors: number of MSI-x vectors, 0 to disable MSI-X
105 #
106 # Since: 1.2
107 ##
108 { 'struct': 'NetLegacyNicOptions',
109   'data': {
110     '*netdev':  'str',
111     '*macaddr': 'str',
112     '*model':   'str',
113     '*addr':    'str',
114     '*vectors': 'uint32' } }
115
116 ##
117 # @NetdevUserOptions:
118 #
119 # Use the user mode network stack which requires no administrator privilege to
120 # run.
121 #
122 # @hostname: client hostname reported by the builtin DHCP server
123 #
124 # @restrict: isolate the guest from the host
125 #
126 # @ipv4: whether to support IPv4, default true for enabled
127 #        (since 2.6)
128 #
129 # @ipv6: whether to support IPv6, default true for enabled
130 #        (since 2.6)
131 #
132 # @ip: legacy parameter, use net= instead
133 #
134 # @net: IP network address that the guest will see, in the
135 #       form addr[/netmask] The netmask is optional, and can be
136 #       either in the form a.b.c.d or as a number of valid top-most
137 #       bits. Default is 10.0.2.0/24.
138 #
139 # @host: guest-visible address of the host
140 #
141 # @tftp: root directory of the built-in TFTP server
142 #
143 # @bootfile: BOOTP filename, for use with tftp=
144 #
145 # @dhcpstart: the first of the 16 IPs the built-in DHCP server can
146 #             assign
147 #
148 # @dns: guest-visible address of the virtual nameserver
149 #
150 # @dnssearch: list of DNS suffixes to search, passed as DHCP option
151 #             to the guest
152 #
153 # @domainname: guest-visible domain name of the virtual nameserver
154 #              (since 3.0)
155 #
156 # @ipv6-prefix: IPv6 network prefix (default is fec0::) (since
157 #               2.6). The network prefix is given in the usual
158 #               hexadecimal IPv6 address notation.
159 #
160 # @ipv6-prefixlen: IPv6 network prefix length (default is 64)
161 #                  (since 2.6)
162 #
163 # @ipv6-host: guest-visible IPv6 address of the host (since 2.6)
164 #
165 # @ipv6-dns: guest-visible IPv6 address of the virtual
166 #            nameserver (since 2.6)
167 #
168 # @smb: root directory of the built-in SMB server
169 #
170 # @smbserver: IP address of the built-in SMB server
171 #
172 # @hostfwd: redirect incoming TCP or UDP host connections to guest
173 #           endpoints
174 #
175 # @guestfwd: forward guest TCP connections
176 #
177 # @tftp-server-name: RFC2132 "TFTP server name" string (Since 3.1)
178 #
179 # Since: 1.2
180 ##
181 { 'struct': 'NetdevUserOptions',
182   'data': {
183     '*hostname':  'str',
184     '*restrict':  'bool',
185     '*ipv4':      'bool',
186     '*ipv6':      'bool',
187     '*ip':        'str',
188     '*net':       'str',
189     '*host':      'str',
190     '*tftp':      'str',
191     '*bootfile':  'str',
192     '*dhcpstart': 'str',
193     '*dns':       'str',
194     '*dnssearch': ['String'],
195     '*domainname': 'str',
196     '*ipv6-prefix':      'str',
197     '*ipv6-prefixlen':   'int',
198     '*ipv6-host':        'str',
199     '*ipv6-dns':         'str',
200     '*smb':       'str',
201     '*smbserver': 'str',
202     '*hostfwd':   ['String'],
203     '*guestfwd':  ['String'],
204     '*tftp-server-name': 'str' } }
205
206 ##
207 # @NetdevTapOptions:
208 #
209 # Used to configure a host TAP network interface backend.
210 #
211 # @ifname: interface name
212 #
213 # @fd: file descriptor of an already opened tap
214 #
215 # @fds: multiple file descriptors of already opened multiqueue capable
216 #       tap
217 #
218 # @script: script to initialize the interface
219 #
220 # @downscript: script to shut down the interface
221 #
222 # @br: bridge name (since 2.8)
223 #
224 # @helper: command to execute to configure bridge
225 #
226 # @sndbuf: send buffer limit. Understands [TGMKkb] suffixes.
227 #
228 # @vnet_hdr: enable the IFF_VNET_HDR flag on the tap interface
229 #
230 # @vhost: enable vhost-net network accelerator
231 #
232 # @vhostfd: file descriptor of an already opened vhost net device
233 #
234 # @vhostfds: file descriptors of multiple already opened vhost net
235 #            devices
236 #
237 # @vhostforce: vhost on for non-MSIX virtio guests
238 #
239 # @queues: number of queues to be created for multiqueue capable tap
240 #
241 # @poll-us: maximum number of microseconds that could
242 #           be spent on busy polling for tap (since 2.7)
243 #
244 # Since: 1.2
245 ##
246 { 'struct': 'NetdevTapOptions',
247   'data': {
248     '*ifname':     'str',
249     '*fd':         'str',
250     '*fds':        'str',
251     '*script':     'str',
252     '*downscript': 'str',
253     '*br':         'str',
254     '*helper':     'str',
255     '*sndbuf':     'size',
256     '*vnet_hdr':   'bool',
257     '*vhost':      'bool',
258     '*vhostfd':    'str',
259     '*vhostfds':   'str',
260     '*vhostforce': 'bool',
261     '*queues':     'uint32',
262     '*poll-us':    'uint32'} }
263
264 ##
265 # @NetdevSocketOptions:
266 #
267 # Socket netdevs are used to establish a network connection to another
268 # QEMU virtual machine via a TCP socket.
269 #
270 # @fd: file descriptor of an already opened socket
271 #
272 # @listen: port number, and optional hostname, to listen on
273 #
274 # @connect: port number, and optional hostname, to connect to
275 #
276 # @mcast: UDP multicast address and port number
277 #
278 # @localaddr: source address and port for multicast and udp packets
279 #
280 # @udp: UDP unicast address and port number
281 #
282 # Since: 1.2
283 ##
284 { 'struct': 'NetdevSocketOptions',
285   'data': {
286     '*fd':        'str',
287     '*listen':    'str',
288     '*connect':   'str',
289     '*mcast':     'str',
290     '*localaddr': 'str',
291     '*udp':       'str' } }
292
293 ##
294 # @NetdevL2TPv3Options:
295 #
296 # Configure an Ethernet over L2TPv3 tunnel.
297 #
298 # @src: source address
299 #
300 # @dst: destination address
301 #
302 # @srcport: source port - mandatory for udp, optional for ip
303 #
304 # @dstport: destination port - mandatory for udp, optional for ip
305 #
306 # @ipv6: force the use of ipv6
307 #
308 # @udp: use the udp version of l2tpv3 encapsulation
309 #
310 # @cookie64: use 64 bit coookies
311 #
312 # @counter: have sequence counter
313 #
314 # @pincounter: pin sequence counter to zero -
315 #              workaround for buggy implementations or
316 #              networks with packet reorder
317 #
318 # @txcookie: 32 or 64 bit transmit cookie
319 #
320 # @rxcookie: 32 or 64 bit receive cookie
321 #
322 # @txsession: 32 bit transmit session
323 #
324 # @rxsession: 32 bit receive session - if not specified
325 #             set to the same value as transmit
326 #
327 # @offset: additional offset - allows the insertion of
328 #          additional application-specific data before the packet payload
329 #
330 # Since: 2.1
331 ##
332 { 'struct': 'NetdevL2TPv3Options',
333   'data': {
334     'src':          'str',
335     'dst':          'str',
336     '*srcport':     'str',
337     '*dstport':     'str',
338     '*ipv6':        'bool',
339     '*udp':         'bool',
340     '*cookie64':    'bool',
341     '*counter':     'bool',
342     '*pincounter':  'bool',
343     '*txcookie':    'uint64',
344     '*rxcookie':    'uint64',
345     'txsession':    'uint32',
346     '*rxsession':   'uint32',
347     '*offset':      'uint32' } }
348
349 ##
350 # @NetdevVdeOptions:
351 #
352 # Connect to a vde switch running on the host.
353 #
354 # @sock: socket path
355 #
356 # @port: port number
357 #
358 # @group: group owner of socket
359 #
360 # @mode: permissions for socket
361 #
362 # Since: 1.2
363 ##
364 { 'struct': 'NetdevVdeOptions',
365   'data': {
366     '*sock':  'str',
367     '*port':  'uint16',
368     '*group': 'str',
369     '*mode':  'uint16' } }
370
371 ##
372 # @NetdevBridgeOptions:
373 #
374 # Connect a host TAP network interface to a host bridge device.
375 #
376 # @br: bridge name
377 #
378 # @helper: command to execute to configure bridge
379 #
380 # Since: 1.2
381 ##
382 { 'struct': 'NetdevBridgeOptions',
383   'data': {
384     '*br':     'str',
385     '*helper': 'str' } }
386
387 ##
388 # @NetdevHubPortOptions:
389 #
390 # Connect two or more net clients through a software hub.
391 #
392 # @hubid: hub identifier number
393 # @netdev: used to connect hub to a netdev instead of a device (since 2.12)
394 #
395 # Since: 1.2
396 ##
397 { 'struct': 'NetdevHubPortOptions',
398   'data': {
399     'hubid':     'int32',
400     '*netdev':    'str' } }
401
402 ##
403 # @NetdevNetmapOptions:
404 #
405 # Connect a client to a netmap-enabled NIC or to a VALE switch port
406 #
407 # @ifname: Either the name of an existing network interface supported by
408 #          netmap, or the name of a VALE port (created on the fly).
409 #          A VALE port name is in the form 'valeXXX:YYY', where XXX and
410 #          YYY are non-negative integers. XXX identifies a switch and
411 #          YYY identifies a port of the switch. VALE ports having the
412 #          same XXX are therefore connected to the same switch.
413 #
414 # @devname: path of the netmap device (default: '/dev/netmap').
415 #
416 # Since: 2.0
417 ##
418 { 'struct': 'NetdevNetmapOptions',
419   'data': {
420     'ifname':     'str',
421     '*devname':    'str' } }
422
423 ##
424 # @NetdevVhostUserOptions:
425 #
426 # Vhost-user network backend
427 #
428 # @chardev: name of a unix socket chardev
429 #
430 # @vhostforce: vhost on for non-MSIX virtio guests (default: false).
431 #
432 # @queues: number of queues to be created for multiqueue vhost-user
433 #          (default: 1) (Since 2.5)
434 #
435 # Since: 2.1
436 ##
437 { 'struct': 'NetdevVhostUserOptions',
438   'data': {
439     'chardev':        'str',
440     '*vhostforce':    'bool',
441     '*queues':        'int' } }
442
443 ##
444 # @NetClientDriver:
445 #
446 # Available netdev drivers.
447 #
448 # Since: 2.7
449 ##
450 { 'enum': 'NetClientDriver',
451   'data': [ 'none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'vde',
452             'bridge', 'hubport', 'netmap', 'vhost-user' ] }
453
454 ##
455 # @Netdev:
456 #
457 # Captures the configuration of a network device.
458 #
459 # @id: identifier for monitor commands.
460 #
461 # @type: Specify the driver used for interpreting remaining arguments.
462 #
463 # Since: 1.2
464 #
465 #        'l2tpv3' - since 2.1
466 ##
467 { 'union': 'Netdev',
468   'base': { 'id': 'str', 'type': 'NetClientDriver' },
469   'discriminator': 'type',
470   'data': {
471     'nic':      'NetLegacyNicOptions',
472     'user':     'NetdevUserOptions',
473     'tap':      'NetdevTapOptions',
474     'l2tpv3':   'NetdevL2TPv3Options',
475     'socket':   'NetdevSocketOptions',
476     'vde':      'NetdevVdeOptions',
477     'bridge':   'NetdevBridgeOptions',
478     'hubport':  'NetdevHubPortOptions',
479     'netmap':   'NetdevNetmapOptions',
480     'vhost-user': 'NetdevVhostUserOptions' } }
481
482 ##
483 # @NetLegacy:
484 #
485 # Captures the configuration of a network device; legacy.
486 #
487 # @id: identifier for monitor commands
488 #
489 # @name: identifier for monitor commands, ignored if @id is present
490 #
491 # @opts: device type specific properties (legacy)
492 #
493 # Since: 1.2
494 ##
495 { 'struct': 'NetLegacy',
496   'data': {
497     '*id':   'str',
498     '*name': 'str',
499     'opts':  'NetLegacyOptions' } }
500
501 ##
502 # @NetLegacyOptionsType:
503 #
504 # Since: 1.2
505 ##
506 { 'enum': 'NetLegacyOptionsType',
507   'data': ['none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'vde',
508            'bridge', 'netmap', 'vhost-user'] }
509
510 ##
511 # @NetLegacyOptions:
512 #
513 # Like Netdev, but for use only by the legacy command line options
514 #
515 # Since: 1.2
516 ##
517 { 'union': 'NetLegacyOptions',
518   'base': { 'type': 'NetLegacyOptionsType' },
519   'discriminator': 'type',
520   'data': {
521     'nic':      'NetLegacyNicOptions',
522     'user':     'NetdevUserOptions',
523     'tap':      'NetdevTapOptions',
524     'l2tpv3':   'NetdevL2TPv3Options',
525     'socket':   'NetdevSocketOptions',
526     'vde':      'NetdevVdeOptions',
527     'bridge':   'NetdevBridgeOptions',
528     'netmap':   'NetdevNetmapOptions',
529     'vhost-user': 'NetdevVhostUserOptions' } }
530
531 ##
532 # @NetFilterDirection:
533 #
534 # Indicates whether a netfilter is attached to a netdev's transmit queue or
535 # receive queue or both.
536 #
537 # @all: the filter is attached both to the receive and the transmit
538 #       queue of the netdev (default).
539 #
540 # @rx: the filter is attached to the receive queue of the netdev,
541 #      where it will receive packets sent to the netdev.
542 #
543 # @tx: the filter is attached to the transmit queue of the netdev,
544 #      where it will receive packets sent by the netdev.
545 #
546 # Since: 2.5
547 ##
548 { 'enum': 'NetFilterDirection',
549   'data': [ 'all', 'rx', 'tx' ] }
550
551 ##
552 # @RxState:
553 #
554 # Packets receiving state
555 #
556 # @normal: filter assigned packets according to the mac-table
557 #
558 # @none: don't receive any assigned packet
559 #
560 # @all: receive all assigned packets
561 #
562 # Since: 1.6
563 ##
564 { 'enum': 'RxState', 'data': [ 'normal', 'none', 'all' ] }
565
566 ##
567 # @RxFilterInfo:
568 #
569 # Rx-filter information for a NIC.
570 #
571 # @name: net client name
572 #
573 # @promiscuous: whether promiscuous mode is enabled
574 #
575 # @multicast: multicast receive state
576 #
577 # @unicast: unicast receive state
578 #
579 # @vlan: vlan receive state (Since 2.0)
580 #
581 # @broadcast-allowed: whether to receive broadcast
582 #
583 # @multicast-overflow: multicast table is overflowed or not
584 #
585 # @unicast-overflow: unicast table is overflowed or not
586 #
587 # @main-mac: the main macaddr string
588 #
589 # @vlan-table: a list of active vlan id
590 #
591 # @unicast-table: a list of unicast macaddr string
592 #
593 # @multicast-table: a list of multicast macaddr string
594 #
595 # Since: 1.6
596 ##
597 { 'struct': 'RxFilterInfo',
598   'data': {
599     'name':               'str',
600     'promiscuous':        'bool',
601     'multicast':          'RxState',
602     'unicast':            'RxState',
603     'vlan':               'RxState',
604     'broadcast-allowed':  'bool',
605     'multicast-overflow': 'bool',
606     'unicast-overflow':   'bool',
607     'main-mac':           'str',
608     'vlan-table':         ['int'],
609     'unicast-table':      ['str'],
610     'multicast-table':    ['str'] }}
611
612 ##
613 # @query-rx-filter:
614 #
615 # Return rx-filter information for all NICs (or for the given NIC).
616 #
617 # @name: net client name
618 #
619 # Returns: list of @RxFilterInfo for all NICs (or for the given NIC).
620 #          Returns an error if the given @name doesn't exist, or given
621 #          NIC doesn't support rx-filter querying, or given net client
622 #          isn't a NIC.
623 #
624 # Since: 1.6
625 #
626 # Example:
627 #
628 # -> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
629 # <- { "return": [
630 #         {
631 #             "promiscuous": true,
632 #             "name": "vnet0",
633 #             "main-mac": "52:54:00:12:34:56",
634 #             "unicast": "normal",
635 #             "vlan": "normal",
636 #             "vlan-table": [
637 #                 4,
638 #                 0
639 #             ],
640 #             "unicast-table": [
641 #             ],
642 #             "multicast": "normal",
643 #             "multicast-overflow": false,
644 #             "unicast-overflow": false,
645 #             "multicast-table": [
646 #                 "01:00:5e:00:00:01",
647 #                 "33:33:00:00:00:01",
648 #                 "33:33:ff:12:34:56"
649 #             ],
650 #             "broadcast-allowed": false
651 #         }
652 #       ]
653 #    }
654 #
655 ##
656 { 'command': 'query-rx-filter',
657   'data': { '*name': 'str' },
658   'returns': ['RxFilterInfo'] }
659
660 ##
661 # @NIC_RX_FILTER_CHANGED:
662 #
663 # Emitted once until the 'query-rx-filter' command is executed, the first event
664 # will always be emitted
665 #
666 # @name: net client name
667 #
668 # @path: device path
669 #
670 # Since: 1.6
671 #
672 # Example:
673 #
674 # <- { "event": "NIC_RX_FILTER_CHANGED",
675 #      "data": { "name": "vnet0",
676 #                "path": "/machine/peripheral/vnet0/virtio-backend" },
677 #      "timestamp": { "seconds": 1368697518, "microseconds": 326866 } }
678 #    }
679 #
680 ##
681 { 'event': 'NIC_RX_FILTER_CHANGED',
682   'data': { '*name': 'str', 'path': 'str' } }
683
684 ##
685 # @AnnounceParameters:
686 #
687 # Parameters for self-announce timers
688 #
689 # @initial: Initial delay (in ms) before sending the first GARP/RARP
690 #           announcement
691 #
692 # @max: Maximum delay (in ms) between GARP/RARP announcement packets
693 #
694 # @rounds: Number of self-announcement attempts
695 #
696 # @step: Delay increase (in ms) after each self-announcement attempt
697 #
698 # @interfaces: An optional list of interface names, which restricts the
699 #              announcement to the listed interfaces. (Since 4.1)
700 #
701 # @id: A name to be used to identify an instance of announce-timers
702 #      and to allow it to modified later.  Not for use as
703 #      part of the migration parameters. (Since 4.1)
704 #
705 # Since: 4.0
706 ##
707
708 { 'struct': 'AnnounceParameters',
709   'data': { 'initial': 'int',
710             'max': 'int',
711             'rounds': 'int',
712             'step': 'int',
713             '*interfaces': ['str'],
714             '*id' : 'str' } }
715
716 ##
717 # @announce-self:
718 #
719 # Trigger generation of broadcast RARP frames to update network switches.
720 # This can be useful when network bonds fail-over the active slave.
721 #
722 # Example:
723 #
724 # -> { "execute": "announce-self",
725 #      "arguments": {
726 #          "initial": 50, "max": 550, "rounds": 10, "step": 50,
727 #          "interfaces": ["vn2", "vn3"], "id": "bob" } }
728 # <- { "return": {} }
729 #
730 # Since: 4.0
731 ##
732 { 'command': 'announce-self', 'boxed': true,
733   'data' : 'AnnounceParameters'}
734
735 ##
736 # @FAILOVER_NEGOTIATED:
737 #
738 # Emitted when VIRTIO_NET_F_STANDBY was enabled during feature negotiation.
739 # Failover primary devices which were hidden (not hotplugged when requested)
740 # before will now be hotplugged by the virtio-net standby device.
741 #
742 # device-id: QEMU device id of the unplugged device
743 # Since: 4.2
744 #
745 # Example:
746 #
747 # <- { "event": "FAILOVER_NEGOTIATED",
748 #      "data": "net1" }
749 #
750 ##
751 { 'event': 'FAILOVER_NEGOTIATED',
752   'data': {'device-id': 'str'} }
This page took 0.064114 seconds and 4 git commands to generate.