8 { 'include': 'common.json' }
13 # Sets the link status of a virtual network adapter.
15 # @name: the device name of the virtual network adapter
17 # @up: true to set the link status to be up
19 # Returns: Nothing on success
20 # If @name is not a valid network device, DeviceNotFound
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
30 # -> { "execute": "set_link",
31 # "arguments": { "name": "e1000.0", "up": false } }
35 { 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
40 # Add a network backend.
42 # @type: the type of network backend. Possible values are listed in
43 # NetClientDriver (excluding 'none' and 'nic')
45 # @id: the name of the new network backend
47 # Additional arguments depend on the type.
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.
56 # Returns: Nothing on success
57 # If @type is not a valid network backend, DeviceNotFound
61 # -> { "execute": "netdev_add",
62 # "arguments": { "type": "user", "id": "netdev1",
63 # "dnssearch": "example.org" } }
67 { 'command': 'netdev_add',
68 'data': {'type': 'str', 'id': 'str'},
69 'gen': false } # so we can get the additional arguments
74 # Remove a network backend.
76 # @id: the name of the network backend to remove
78 # Returns: Nothing on success
79 # If @id is not a valid network backend, DeviceNotFound
85 # -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
89 { 'command': 'netdev_del', 'data': {'id': 'str'} }
92 # @NetLegacyNicOptions:
94 # Create a new Network Interface Card.
96 # @netdev: id of -netdev to connect to
98 # @macaddr: MAC address
100 # @model: device model (e1000, rtl8139, virtio etc.)
102 # @addr: PCI device address
104 # @vectors: number of MSI-x vectors, 0 to disable MSI-X
108 { 'struct': 'NetLegacyNicOptions',
114 '*vectors': 'uint32' } }
117 # @NetdevUserOptions:
119 # Use the user mode network stack which requires no administrator privilege to
122 # @hostname: client hostname reported by the builtin DHCP server
124 # @restrict: isolate the guest from the host
126 # @ipv4: whether to support IPv4, default true for enabled
129 # @ipv6: whether to support IPv6, default true for enabled
132 # @ip: legacy parameter, use net= instead
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.
139 # @host: guest-visible address of the host
141 # @tftp: root directory of the built-in TFTP server
143 # @bootfile: BOOTP filename, for use with tftp=
145 # @dhcpstart: the first of the 16 IPs the built-in DHCP server can
148 # @dns: guest-visible address of the virtual nameserver
150 # @dnssearch: list of DNS suffixes to search, passed as DHCP option
153 # @domainname: guest-visible domain name of the virtual nameserver
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.
160 # @ipv6-prefixlen: IPv6 network prefix length (default is 64)
163 # @ipv6-host: guest-visible IPv6 address of the host (since 2.6)
165 # @ipv6-dns: guest-visible IPv6 address of the virtual
166 # nameserver (since 2.6)
168 # @smb: root directory of the built-in SMB server
170 # @smbserver: IP address of the built-in SMB server
172 # @hostfwd: redirect incoming TCP or UDP host connections to guest
175 # @guestfwd: forward guest TCP connections
177 # @tftp-server-name: RFC2132 "TFTP server name" string (Since 3.1)
181 { 'struct': 'NetdevUserOptions',
194 '*dnssearch': ['String'],
195 '*domainname': 'str',
196 '*ipv6-prefix': 'str',
197 '*ipv6-prefixlen': 'int',
202 '*hostfwd': ['String'],
203 '*guestfwd': ['String'],
204 '*tftp-server-name': 'str' } }
209 # Used to configure a host TAP network interface backend.
211 # @ifname: interface name
213 # @fd: file descriptor of an already opened tap
215 # @fds: multiple file descriptors of already opened multiqueue capable
218 # @script: script to initialize the interface
220 # @downscript: script to shut down the interface
222 # @br: bridge name (since 2.8)
224 # @helper: command to execute to configure bridge
226 # @sndbuf: send buffer limit. Understands [TGMKkb] suffixes.
228 # @vnet_hdr: enable the IFF_VNET_HDR flag on the tap interface
230 # @vhost: enable vhost-net network accelerator
232 # @vhostfd: file descriptor of an already opened vhost net device
234 # @vhostfds: file descriptors of multiple already opened vhost net
237 # @vhostforce: vhost on for non-MSIX virtio guests
239 # @queues: number of queues to be created for multiqueue capable tap
241 # @poll-us: maximum number of microseconds that could
242 # be spent on busy polling for tap (since 2.7)
246 { 'struct': 'NetdevTapOptions',
252 '*downscript': 'str',
260 '*vhostforce': 'bool',
262 '*poll-us': 'uint32'} }
265 # @NetdevSocketOptions:
267 # Socket netdevs are used to establish a network connection to another
268 # QEMU virtual machine via a TCP socket.
270 # @fd: file descriptor of an already opened socket
272 # @listen: port number, and optional hostname, to listen on
274 # @connect: port number, and optional hostname, to connect to
276 # @mcast: UDP multicast address and port number
278 # @localaddr: source address and port for multicast and udp packets
280 # @udp: UDP unicast address and port number
284 { 'struct': 'NetdevSocketOptions',
294 # @NetdevL2TPv3Options:
296 # Configure an Ethernet over L2TPv3 tunnel.
298 # @src: source address
300 # @dst: destination address
302 # @srcport: source port - mandatory for udp, optional for ip
304 # @dstport: destination port - mandatory for udp, optional for ip
306 # @ipv6: force the use of ipv6
308 # @udp: use the udp version of l2tpv3 encapsulation
310 # @cookie64: use 64 bit coookies
312 # @counter: have sequence counter
314 # @pincounter: pin sequence counter to zero -
315 # workaround for buggy implementations or
316 # networks with packet reorder
318 # @txcookie: 32 or 64 bit transmit cookie
320 # @rxcookie: 32 or 64 bit receive cookie
322 # @txsession: 32 bit transmit session
324 # @rxsession: 32 bit receive session - if not specified
325 # set to the same value as transmit
327 # @offset: additional offset - allows the insertion of
328 # additional application-specific data before the packet payload
332 { 'struct': 'NetdevL2TPv3Options',
342 '*pincounter': 'bool',
343 '*txcookie': 'uint64',
344 '*rxcookie': 'uint64',
345 'txsession': 'uint32',
346 '*rxsession': 'uint32',
347 '*offset': 'uint32' } }
352 # Connect to a vde switch running on the host.
358 # @group: group owner of socket
360 # @mode: permissions for socket
364 { 'struct': 'NetdevVdeOptions',
369 '*mode': 'uint16' } }
372 # @NetdevBridgeOptions:
374 # Connect a host TAP network interface to a host bridge device.
378 # @helper: command to execute to configure bridge
382 { 'struct': 'NetdevBridgeOptions',
388 # @NetdevHubPortOptions:
390 # Connect two or more net clients through a software hub.
392 # @hubid: hub identifier number
393 # @netdev: used to connect hub to a netdev instead of a device (since 2.12)
397 { 'struct': 'NetdevHubPortOptions',
403 # @NetdevNetmapOptions:
405 # Connect a client to a netmap-enabled NIC or to a VALE switch port
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.
414 # @devname: path of the netmap device (default: '/dev/netmap').
418 { 'struct': 'NetdevNetmapOptions',
421 '*devname': 'str' } }
424 # @NetdevVhostUserOptions:
426 # Vhost-user network backend
428 # @chardev: name of a unix socket chardev
430 # @vhostforce: vhost on for non-MSIX virtio guests (default: false).
432 # @queues: number of queues to be created for multiqueue vhost-user
433 # (default: 1) (Since 2.5)
437 { 'struct': 'NetdevVhostUserOptions',
440 '*vhostforce': 'bool',
446 # Available netdev drivers.
450 { 'enum': 'NetClientDriver',
451 'data': [ 'none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'vde',
452 'bridge', 'hubport', 'netmap', 'vhost-user' ] }
457 # Captures the configuration of a network device.
459 # @id: identifier for monitor commands.
461 # @type: Specify the driver used for interpreting remaining arguments.
465 # 'l2tpv3' - since 2.1
468 'base': { 'id': 'str', 'type': 'NetClientDriver' },
469 'discriminator': 'type',
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' } }
485 # Captures the configuration of a network device; legacy.
487 # @id: identifier for monitor commands
489 # @name: identifier for monitor commands, ignored if @id is present
491 # @opts: device type specific properties (legacy)
495 { 'struct': 'NetLegacy',
499 'opts': 'NetLegacyOptions' } }
502 # @NetLegacyOptionsType:
506 { 'enum': 'NetLegacyOptionsType',
507 'data': ['none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'vde',
508 'bridge', 'netmap', 'vhost-user'] }
513 # Like Netdev, but for use only by the legacy command line options
517 { 'union': 'NetLegacyOptions',
518 'base': { 'type': 'NetLegacyOptionsType' },
519 'discriminator': 'type',
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' } }
532 # @NetFilterDirection:
534 # Indicates whether a netfilter is attached to a netdev's transmit queue or
535 # receive queue or both.
537 # @all: the filter is attached both to the receive and the transmit
538 # queue of the netdev (default).
540 # @rx: the filter is attached to the receive queue of the netdev,
541 # where it will receive packets sent to the netdev.
543 # @tx: the filter is attached to the transmit queue of the netdev,
544 # where it will receive packets sent by the netdev.
548 { 'enum': 'NetFilterDirection',
549 'data': [ 'all', 'rx', 'tx' ] }
554 # Packets receiving state
556 # @normal: filter assigned packets according to the mac-table
558 # @none: don't receive any assigned packet
560 # @all: receive all assigned packets
564 { 'enum': 'RxState', 'data': [ 'normal', 'none', 'all' ] }
569 # Rx-filter information for a NIC.
571 # @name: net client name
573 # @promiscuous: whether promiscuous mode is enabled
575 # @multicast: multicast receive state
577 # @unicast: unicast receive state
579 # @vlan: vlan receive state (Since 2.0)
581 # @broadcast-allowed: whether to receive broadcast
583 # @multicast-overflow: multicast table is overflowed or not
585 # @unicast-overflow: unicast table is overflowed or not
587 # @main-mac: the main macaddr string
589 # @vlan-table: a list of active vlan id
591 # @unicast-table: a list of unicast macaddr string
593 # @multicast-table: a list of multicast macaddr string
597 { 'struct': 'RxFilterInfo',
600 'promiscuous': 'bool',
601 'multicast': 'RxState',
602 'unicast': 'RxState',
604 'broadcast-allowed': 'bool',
605 'multicast-overflow': 'bool',
606 'unicast-overflow': 'bool',
608 'vlan-table': ['int'],
609 'unicast-table': ['str'],
610 'multicast-table': ['str'] }}
615 # Return rx-filter information for all NICs (or for the given NIC).
617 # @name: net client name
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
628 # -> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
631 # "promiscuous": true,
633 # "main-mac": "52:54:00:12:34:56",
634 # "unicast": "normal",
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"
650 # "broadcast-allowed": false
656 { 'command': 'query-rx-filter',
657 'data': { '*name': 'str' },
658 'returns': ['RxFilterInfo'] }
661 # @NIC_RX_FILTER_CHANGED:
663 # Emitted once until the 'query-rx-filter' command is executed, the first event
664 # will always be emitted
666 # @name: net client name
674 # <- { "event": "NIC_RX_FILTER_CHANGED",
675 # "data": { "name": "vnet0",
676 # "path": "/machine/peripheral/vnet0/virtio-backend" },
677 # "timestamp": { "seconds": 1368697518, "microseconds": 326866 } }
681 { 'event': 'NIC_RX_FILTER_CHANGED',
682 'data': { '*name': 'str', 'path': 'str' } }
685 # @AnnounceParameters:
687 # Parameters for self-announce timers
689 # @initial: Initial delay (in ms) before sending the first GARP/RARP
692 # @max: Maximum delay (in ms) between GARP/RARP announcement packets
694 # @rounds: Number of self-announcement attempts
696 # @step: Delay increase (in ms) after each self-announcement attempt
698 # @interfaces: An optional list of interface names, which restricts the
699 # announcement to the listed interfaces. (Since 4.1)
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)
708 { 'struct': 'AnnounceParameters',
709 'data': { 'initial': 'int',
713 '*interfaces': ['str'],
719 # Trigger generation of broadcast RARP frames to update network switches.
720 # This can be useful when network bonds fail-over the active slave.
724 # -> { "execute": "announce-self",
726 # "initial": 50, "max": 550, "rounds": 10, "step": 50,
727 # "interfaces": ["vn2", "vn3"], "id": "bob" } }
728 # <- { "return": {} }
732 { 'command': 'announce-self', 'boxed': true,
733 'data' : 'AnnounceParameters'}
736 # @FAILOVER_NEGOTIATED:
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.
742 # device-id: QEMU device id of the unplugged device
747 # <- { "event": "FAILOVER_NEGOTIATED",
751 { 'event': 'FAILOVER_NEGOTIATED',
752 'data': {'device-id': 'str'} }