1# -*- Mode: Python -*- 2# vim: filetype=python 3# 4 5## 6# = Net devices 7## 8 9{ 'include': 'sockets.json' } 10 11## 12# @set_link: 13# 14# Sets the link status of a virtual network adapter. 15# 16# @name: the device name of the virtual network adapter 17# 18# @up: true to set the link status to be up 19# 20# Errors: 21# - If @name is not a valid network device, DeviceNotFound 22# 23# Since: 0.14 24# 25# .. note:: Not all network adapters support setting link status. 26# This command will succeed even if the network adapter does not 27# support link status notification. 28# 29# .. qmp-example:: 30# 31# -> { "execute": "set_link", 32# "arguments": { "name": "e1000.0", "up": false } } 33# <- { "return": {} } 34## 35{ 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} } 36 37## 38# @netdev_add: 39# 40# Add a network backend. 41# 42# Additional arguments depend on the type. 43# 44# Since: 0.14 45# 46# Errors: 47# - If @type is not a valid network backend, DeviceNotFound 48# 49# .. qmp-example:: 50# 51# -> { "execute": "netdev_add", 52# "arguments": { "type": "user", "id": "netdev1", 53# "dnssearch": [ { "str": "example.org" } ] } } 54# <- { "return": {} } 55## 56{ 'command': 'netdev_add', 'data': 'Netdev', 'boxed': true, 57 'allow-preconfig': true } 58 59## 60# @netdev_del: 61# 62# Remove a network backend. 63# 64# @id: the name of the network backend to remove 65# 66# Errors: 67# - If @id is not a valid network backend, DeviceNotFound 68# 69# Since: 0.14 70# 71# .. qmp-example:: 72# 73# -> { "execute": "netdev_del", "arguments": { "id": "netdev1" } } 74# <- { "return": {} } 75## 76{ 'command': 'netdev_del', 'data': {'id': 'str'}, 77 'allow-preconfig': true } 78 79## 80# @NetLegacyNicOptions: 81# 82# Create a new Network Interface Card. 83# 84# @netdev: id of -netdev to connect to 85# 86# @macaddr: MAC address 87# 88# @model: device model (e1000, rtl8139, virtio etc.) 89# 90# @addr: PCI device address 91# 92# @vectors: number of MSI-x vectors, 0 to disable MSI-X 93# 94# Since: 1.2 95## 96{ 'struct': 'NetLegacyNicOptions', 97 'data': { 98 '*netdev': 'str', 99 '*macaddr': 'str', 100 '*model': 'str', 101 '*addr': 'str', 102 '*vectors': 'uint32' } } 103 104## 105# @String: 106# 107# A fat type wrapping 'str', to be embedded in lists. 108# 109# Since: 1.2 110## 111{ 'struct': 'String', 112 'data': { 113 'str': 'str' } } 114 115## 116# @NetdevUserOptions: 117# 118# Use the user mode network stack which requires no administrator 119# privilege to run. 120# 121# @hostname: client hostname reported by the builtin DHCP server 122# 123# @restrict: isolate the guest from the host 124# 125# @ipv4: whether to support IPv4, default true for enabled (since 2.6) 126# 127# @ipv6: whether to support IPv6, default true for enabled (since 2.6) 128# 129# @ip: legacy parameter, use net= instead 130# 131# @net: IP network address that the guest will see, in the form 132# addr[/netmask] The netmask is optional, and can be either in the 133# form a.b.c.d or as a number of valid top-most bits. Default is 134# 10.0.2.0/24. 135# 136# @host: guest-visible address of the host 137# 138# @tftp: root directory of the built-in TFTP server 139# 140# @bootfile: BOOTP filename, for use with tftp= 141# 142# @dhcpstart: the first of the 16 IPs the built-in DHCP server can 143# assign 144# 145# @dns: guest-visible address of the virtual nameserver 146# 147# @dnssearch: list of DNS suffixes to search, passed as DHCP option to 148# the guest 149# 150# @domainname: guest-visible domain name of the virtual nameserver 151# (since 3.0) 152# 153# @ipv6-prefix: IPv6 network prefix (default is fec0::) (since 2.6). 154# The network prefix is given in the usual hexadecimal IPv6 155# address notation. 156# 157# @ipv6-prefixlen: IPv6 network prefix length (default is 64) (since 158# 2.6) 159# 160# @ipv6-host: guest-visible IPv6 address of the host (since 2.6) 161# 162# @ipv6-dns: guest-visible IPv6 address of the virtual nameserver 163# (since 2.6) 164# 165# @smb: root directory of the built-in SMB server 166# 167# @smbserver: IP address of the built-in SMB server 168# 169# @hostfwd: redirect incoming TCP or UDP host connections to guest 170# endpoints 171# 172# @guestfwd: forward guest TCP connections 173# 174# @tftp-server-name: RFC2132 "TFTP server name" string (Since 3.1) 175# 176# Since: 1.2 177## 178{ 'struct': 'NetdevUserOptions', 179 'data': { 180 '*hostname': 'str', 181 '*restrict': 'bool', 182 '*ipv4': 'bool', 183 '*ipv6': 'bool', 184 '*ip': 'str', 185 '*net': 'str', 186 '*host': 'str', 187 '*tftp': 'str', 188 '*bootfile': 'str', 189 '*dhcpstart': 'str', 190 '*dns': 'str', 191 '*dnssearch': ['String'], 192 '*domainname': 'str', 193 '*ipv6-prefix': 'str', 194 '*ipv6-prefixlen': 'int', 195 '*ipv6-host': 'str', 196 '*ipv6-dns': 'str', 197 '*smb': 'str', 198 '*smbserver': 'str', 199 '*hostfwd': ['String'], 200 '*guestfwd': ['String'], 201 '*tftp-server-name': 'str' } } 202 203## 204# @NetdevTapOptions: 205# 206# Used to configure a host TAP network interface backend. 207# 208# @ifname: interface name 209# 210# @fd: file descriptor of an already opened tap 211# 212# @fds: multiple file descriptors of already opened multiqueue capable 213# tap 214# 215# @script: script to initialize the interface 216# 217# @downscript: script to shut down the interface 218# 219# @br: bridge name (since 2.8) 220# 221# @helper: command to execute to configure bridge 222# 223# @sndbuf: send buffer limit. Understands [TGMKkb] suffixes. 224# 225# @vnet_hdr: enable the IFF_VNET_HDR flag on the tap interface 226# 227# @vhost: enable vhost-net network accelerator 228# 229# @vhostfd: file descriptor of an already opened vhost net device 230# 231# @vhostfds: file descriptors of multiple already opened vhost net 232# devices 233# 234# @vhostforce: vhost on for non-MSIX virtio guests 235# 236# @queues: number of queues to be created for multiqueue capable tap 237# 238# @poll-us: maximum number of microseconds that could be spent on busy 239# polling for tap (since 2.7) 240# 241# Since: 1.2 242## 243{ 'struct': 'NetdevTapOptions', 244 'data': { 245 '*ifname': 'str', 246 '*fd': 'str', 247 '*fds': 'str', 248 '*script': 'str', 249 '*downscript': 'str', 250 '*br': 'str', 251 '*helper': 'str', 252 '*sndbuf': 'size', 253 '*vnet_hdr': 'bool', 254 '*vhost': 'bool', 255 '*vhostfd': 'str', 256 '*vhostfds': 'str', 257 '*vhostforce': 'bool', 258 '*queues': 'uint32', 259 '*poll-us': 'uint32'} } 260 261## 262# @NetdevSocketOptions: 263# 264# Socket netdevs are used to establish a network connection to another 265# QEMU virtual machine via a TCP socket. 266# 267# @fd: file descriptor of an already opened socket 268# 269# @listen: port number, and optional hostname, to listen on 270# 271# @connect: port number, and optional hostname, to connect to 272# 273# @mcast: UDP multicast address and port number 274# 275# @localaddr: source address and port for multicast and udp packets 276# 277# @udp: UDP unicast address and port number 278# 279# Since: 1.2 280## 281{ 'struct': 'NetdevSocketOptions', 282 'data': { 283 '*fd': 'str', 284 '*listen': 'str', 285 '*connect': 'str', 286 '*mcast': 'str', 287 '*localaddr': 'str', 288 '*udp': 'str' } } 289 290## 291# @NetdevL2TPv3Options: 292# 293# Configure an Ethernet over L2TPv3 tunnel. 294# 295# @src: source address 296# 297# @dst: destination address 298# 299# @srcport: source port - mandatory for udp, optional for ip 300# 301# @dstport: destination port - mandatory for udp, optional for ip 302# 303# @ipv6: force the use of ipv6 304# 305# @udp: use the udp version of l2tpv3 encapsulation 306# 307# @cookie64: use 64 bit cookies 308# 309# @counter: have sequence counter 310# 311# @pincounter: pin sequence counter to zero - workaround for buggy 312# implementations or networks with packet reorder 313# 314# @txcookie: 32 or 64 bit transmit cookie 315# 316# @rxcookie: 32 or 64 bit receive cookie 317# 318# @txsession: 32 bit transmit session 319# 320# @rxsession: 32 bit receive session - if not specified set to the 321# same value as transmit 322# 323# @offset: additional offset - allows the insertion of additional 324# application-specific data before the packet payload 325# 326# Since: 2.1 327## 328{ 'struct': 'NetdevL2TPv3Options', 329 'data': { 330 'src': 'str', 331 'dst': 'str', 332 '*srcport': 'str', 333 '*dstport': 'str', 334 '*ipv6': 'bool', 335 '*udp': 'bool', 336 '*cookie64': 'bool', 337 '*counter': 'bool', 338 '*pincounter': 'bool', 339 '*txcookie': 'uint64', 340 '*rxcookie': 'uint64', 341 'txsession': 'uint32', 342 '*rxsession': 'uint32', 343 '*offset': 'uint32' } } 344 345## 346# @NetdevVdeOptions: 347# 348# Connect to a vde switch running on the host. 349# 350# @sock: socket path 351# 352# @port: port number 353# 354# @group: group owner of socket 355# 356# @mode: permissions for socket 357# 358# Since: 1.2 359## 360{ 'struct': 'NetdevVdeOptions', 361 'data': { 362 '*sock': 'str', 363 '*port': 'uint16', 364 '*group': 'str', 365 '*mode': 'uint16' } } 366 367## 368# @NetdevBridgeOptions: 369# 370# Connect a host TAP network interface to a host bridge device. 371# 372# @br: bridge name 373# 374# @helper: command to execute to configure bridge 375# 376# Since: 1.2 377## 378{ 'struct': 'NetdevBridgeOptions', 379 'data': { 380 '*br': 'str', 381 '*helper': 'str' } } 382 383## 384# @NetdevHubPortOptions: 385# 386# Connect two or more net clients through a software hub. 387# 388# @hubid: hub identifier number 389# 390# @netdev: used to connect hub to a netdev instead of a device (since 391# 2.12) 392# 393# Since: 1.2 394## 395{ 'struct': 'NetdevHubPortOptions', 396 'data': { 397 'hubid': 'int32', 398 '*netdev': 'str' } } 399 400## 401# @NetdevNetmapOptions: 402# 403# Connect a client to a netmap-enabled NIC or to a VALE switch port 404# 405# @ifname: Either the name of an existing network interface supported 406# by netmap, or the name of a VALE port (created on the fly). A 407# VALE port name is in the form 'valeXXX:YYY', where XXX and YYY 408# are non-negative integers. XXX identifies a switch and YYY 409# identifies a port of the switch. VALE ports having the same XXX 410# are therefore connected to the same switch. 411# 412# @devname: path of the netmap device (default: '/dev/netmap'). 413# 414# Since: 2.0 415## 416{ 'struct': 'NetdevNetmapOptions', 417 'data': { 418 'ifname': 'str', 419 '*devname': 'str' } } 420 421## 422# @AFXDPMode: 423# 424# Attach mode for a default XDP program 425# 426# @skb: generic mode, no driver support necessary 427# 428# @native: DRV mode, program is attached to a driver, packets are 429# passed to the socket without allocation of skb. 430# 431# Since: 8.2 432## 433{ 'enum': 'AFXDPMode', 434 'data': [ 'native', 'skb' ], 435 'if': 'CONFIG_AF_XDP' } 436 437## 438# @NetdevAFXDPOptions: 439# 440# AF_XDP network backend 441# 442# @ifname: The name of an existing network interface. 443# 444# @mode: Attach mode for a default XDP program. If not specified, 445# then 'native' will be tried first, then 'skb'. 446# 447# @force-copy: Force XDP copy mode even if device supports zero-copy. 448# (default: false) 449# 450# @queues: number of queues to be used for multiqueue interfaces 451# (default: 1). 452# 453# @start-queue: Use @queues starting from this queue number 454# (default: 0). 455# 456# @inhibit: Don't load a default XDP program, use one already loaded 457# to the interface (default: false). Requires @sock-fds. 458# 459# @sock-fds: A colon (:) separated list of file descriptors for 460# already open but not bound AF_XDP sockets in the queue order. 461# One fd per queue. These descriptors should already be added 462# into XDP socket map for corresponding queues. Requires 463# @inhibit. 464# 465# Since: 8.2 466## 467{ 'struct': 'NetdevAFXDPOptions', 468 'data': { 469 'ifname': 'str', 470 '*mode': 'AFXDPMode', 471 '*force-copy': 'bool', 472 '*queues': 'int', 473 '*start-queue': 'int', 474 '*inhibit': 'bool', 475 '*sock-fds': 'str' }, 476 'if': 'CONFIG_AF_XDP' } 477 478## 479# @NetdevVhostUserOptions: 480# 481# Vhost-user network backend 482# 483# @chardev: name of a unix socket chardev 484# 485# @vhostforce: vhost on for non-MSIX virtio guests (default: false). 486# 487# @queues: number of queues to be created for multiqueue vhost-user 488# (default: 1) (Since 2.5) 489# 490# Since: 2.1 491## 492{ 'struct': 'NetdevVhostUserOptions', 493 'data': { 494 'chardev': 'str', 495 '*vhostforce': 'bool', 496 '*queues': 'int' } } 497 498## 499# @NetdevVhostVDPAOptions: 500# 501# Vhost-vdpa network backend 502# 503# vDPA device is a device that uses a datapath which complies with the 504# virtio specifications with a vendor specific control path. 505# 506# @vhostdev: path of vhost-vdpa device (default:'/dev/vhost-vdpa-0') 507# 508# @vhostfd: file descriptor of an already opened vhost vdpa device 509# 510# @queues: number of queues to be created for multiqueue vhost-vdpa 511# (default: 1) 512# 513# @x-svq: Start device with (experimental) shadow virtqueue. (Since 514# 7.1) (default: false) 515# 516# Features: 517# 518# @unstable: Member @x-svq is experimental. 519# 520# Since: 5.1 521## 522{ 'struct': 'NetdevVhostVDPAOptions', 523 'data': { 524 '*vhostdev': 'str', 525 '*vhostfd': 'str', 526 '*queues': 'int', 527 '*x-svq': {'type': 'bool', 'features' : [ 'unstable'] } } } 528 529## 530# @NetdevVmnetHostOptions: 531# 532# vmnet (host mode) network backend. 533# 534# Allows the vmnet interface to communicate with other vmnet 535# interfaces that are in host mode and also with the host. 536# 537# @start-address: The starting IPv4 address to use for the interface. 538# Must be in the private IP range (RFC 1918). Must be specified 539# along with @end-address and @subnet-mask. This address is used 540# as the gateway address. The subsequent address up to and 541# including end-address are placed in the DHCP pool. 542# 543# @end-address: The DHCP IPv4 range end address to use for the 544# interface. Must be in the private IP range (RFC 1918). Must be 545# specified along with @start-address and @subnet-mask. 546# 547# @subnet-mask: The IPv4 subnet mask to use on the interface. Must be 548# specified along with @start-address and @subnet-mask. 549# 550# @isolated: Enable isolation for this interface. Interface isolation 551# ensures that vmnet interface is not able to communicate with any 552# other vmnet interfaces. Only communication with host is 553# allowed. Requires at least macOS Big Sur 11.0. 554# 555# @net-uuid: The identifier (UUID) to uniquely identify the isolated 556# network vmnet interface should be added to. If set, no DHCP 557# service is provided for this interface and network communication 558# is allowed only with other interfaces added to this network 559# identified by the UUID. Requires at least macOS Big Sur 11.0. 560# 561# Since: 7.1 562## 563{ 'struct': 'NetdevVmnetHostOptions', 564 'data': { 565 '*start-address': 'str', 566 '*end-address': 'str', 567 '*subnet-mask': 'str', 568 '*isolated': 'bool', 569 '*net-uuid': 'str' }, 570 'if': 'CONFIG_VMNET' } 571 572## 573# @NetdevVmnetSharedOptions: 574# 575# vmnet (shared mode) network backend. 576# 577# Allows traffic originating from the vmnet interface to reach the 578# Internet through a network address translator (NAT). The vmnet 579# interface can communicate with the host and with other shared mode 580# interfaces on the same subnet. If no DHCP settings, subnet mask and 581# IPv6 prefix specified, the interface can communicate with any of 582# other interfaces in shared mode. 583# 584# @start-address: The starting IPv4 address to use for the interface. 585# Must be in the private IP range (RFC 1918). Must be specified 586# along with @end-address and @subnet-mask. This address is used 587# as the gateway address. The subsequent address up to and 588# including end-address are placed in the DHCP pool. 589# 590# @end-address: The DHCP IPv4 range end address to use for the 591# interface. Must be in the private IP range (RFC 1918). Must be 592# specified along with @start-address and @subnet-mask. 593# 594# @subnet-mask: The IPv4 subnet mask to use on the interface. Must be 595# specified along with @start-address and @subnet-mask. 596# 597# @isolated: Enable isolation for this interface. Interface isolation 598# ensures that vmnet interface is not able to communicate with any 599# other vmnet interfaces. Only communication with host is 600# allowed. Requires at least macOS Big Sur 11.0. 601# 602# @nat66-prefix: The IPv6 prefix to use into guest network. Must be a 603# unique local address i.e. start with fd00::/8 and have length of 604# 64. 605# 606# Since: 7.1 607## 608{ 'struct': 'NetdevVmnetSharedOptions', 609 'data': { 610 '*start-address': 'str', 611 '*end-address': 'str', 612 '*subnet-mask': 'str', 613 '*isolated': 'bool', 614 '*nat66-prefix': 'str' }, 615 'if': 'CONFIG_VMNET' } 616 617## 618# @NetdevVmnetBridgedOptions: 619# 620# vmnet (bridged mode) network backend. 621# 622# Bridges the vmnet interface with a physical network interface. 623# 624# @ifname: The name of the physical interface to be bridged. 625# 626# @isolated: Enable isolation for this interface. Interface isolation 627# ensures that vmnet interface is not able to communicate with any 628# other vmnet interfaces. Only communication with host is 629# allowed. Requires at least macOS Big Sur 11.0. 630# 631# Since: 7.1 632## 633{ 'struct': 'NetdevVmnetBridgedOptions', 634 'data': { 635 'ifname': 'str', 636 '*isolated': 'bool' }, 637 'if': 'CONFIG_VMNET' } 638 639## 640# @NetdevStreamOptions: 641# 642# Configuration info for stream socket netdev 643# 644# @addr: socket address to listen on (server=true) or connect to 645# (server=false) 646# 647# @server: create server socket (default: false) 648# 649# @reconnect: For a client socket, if a socket is disconnected, then 650# attempt a reconnect after the given number of seconds. Setting 651# this to zero disables this function. (default: 0) (since 8.0) 652# 653# Only SocketAddress types 'unix', 'inet' and 'fd' are supported. 654# 655# Since: 7.2 656## 657{ 'struct': 'NetdevStreamOptions', 658 'data': { 659 'addr': 'SocketAddress', 660 '*server': 'bool', 661 '*reconnect': 'uint32' } } 662 663## 664# @NetdevDgramOptions: 665# 666# Configuration info for datagram socket netdev. 667# 668# @remote: remote address 669# 670# @local: local address 671# 672# Only SocketAddress types 'unix', 'inet' and 'fd' are supported. 673# 674# If remote address is present and it's a multicast address, local 675# address is optional. Otherwise local address is required and remote 676# address is optional. 677# 678# .. table:: Valid parameters combination table 679# :widths: auto 680# 681# ============= ======== ===== 682# remote local okay? 683# ============= ======== ===== 684# absent absent no 685# absent not fd no 686# absent fd yes 687# multicast absent yes 688# multicast present yes 689# not multicast absent no 690# not multicast present yes 691# ============= ======== ===== 692# 693# Since: 7.2 694## 695{ 'struct': 'NetdevDgramOptions', 696 'data': { 697 '*local': 'SocketAddress', 698 '*remote': 'SocketAddress' } } 699 700## 701# @NetClientDriver: 702# 703# Available netdev drivers. 704# 705# @l2tpv3: since 2.1 706# 707# @vhost-vdpa: since 5.1 708# 709# @vmnet-host: since 7.1 710# 711# @vmnet-shared: since 7.1 712# 713# @vmnet-bridged: since 7.1 714# 715# @stream: since 7.2 716# 717# @dgram: since 7.2 718# 719# @af-xdp: since 8.2 720# 721# Since: 2.7 722## 723{ 'enum': 'NetClientDriver', 724 'data': [ 'none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'stream', 725 'dgram', 'vde', 'bridge', 'hubport', 'netmap', 'vhost-user', 726 'vhost-vdpa', 727 { 'name': 'af-xdp', 'if': 'CONFIG_AF_XDP' }, 728 { 'name': 'vmnet-host', 'if': 'CONFIG_VMNET' }, 729 { 'name': 'vmnet-shared', 'if': 'CONFIG_VMNET' }, 730 { 'name': 'vmnet-bridged', 'if': 'CONFIG_VMNET' }] } 731 732## 733# @Netdev: 734# 735# Captures the configuration of a network device. 736# 737# @id: identifier for monitor commands. 738# 739# @type: Specify the driver used for interpreting remaining arguments. 740# 741# Since: 1.2 742## 743{ 'union': 'Netdev', 744 'base': { 'id': 'str', 'type': 'NetClientDriver' }, 745 'discriminator': 'type', 746 'data': { 747 'nic': 'NetLegacyNicOptions', 748 'user': 'NetdevUserOptions', 749 'tap': 'NetdevTapOptions', 750 'l2tpv3': 'NetdevL2TPv3Options', 751 'socket': 'NetdevSocketOptions', 752 'stream': 'NetdevStreamOptions', 753 'dgram': 'NetdevDgramOptions', 754 'vde': 'NetdevVdeOptions', 755 'bridge': 'NetdevBridgeOptions', 756 'hubport': 'NetdevHubPortOptions', 757 'netmap': 'NetdevNetmapOptions', 758 'af-xdp': { 'type': 'NetdevAFXDPOptions', 759 'if': 'CONFIG_AF_XDP' }, 760 'vhost-user': 'NetdevVhostUserOptions', 761 'vhost-vdpa': 'NetdevVhostVDPAOptions', 762 'vmnet-host': { 'type': 'NetdevVmnetHostOptions', 763 'if': 'CONFIG_VMNET' }, 764 'vmnet-shared': { 'type': 'NetdevVmnetSharedOptions', 765 'if': 'CONFIG_VMNET' }, 766 'vmnet-bridged': { 'type': 'NetdevVmnetBridgedOptions', 767 'if': 'CONFIG_VMNET' } } } 768 769## 770# @RxState: 771# 772# Packets receiving state 773# 774# @normal: filter assigned packets according to the mac-table 775# 776# @none: don't receive any assigned packet 777# 778# @all: receive all assigned packets 779# 780# Since: 1.6 781## 782{ 'enum': 'RxState', 'data': [ 'normal', 'none', 'all' ] } 783 784## 785# @RxFilterInfo: 786# 787# Rx-filter information for a NIC. 788# 789# @name: net client name 790# 791# @promiscuous: whether promiscuous mode is enabled 792# 793# @multicast: multicast receive state 794# 795# @unicast: unicast receive state 796# 797# @vlan: vlan receive state (Since 2.0) 798# 799# @broadcast-allowed: whether to receive broadcast 800# 801# @multicast-overflow: multicast table is overflowed or not 802# 803# @unicast-overflow: unicast table is overflowed or not 804# 805# @main-mac: the main macaddr string 806# 807# @vlan-table: a list of active vlan id 808# 809# @unicast-table: a list of unicast macaddr string 810# 811# @multicast-table: a list of multicast macaddr string 812# 813# Since: 1.6 814## 815{ 'struct': 'RxFilterInfo', 816 'data': { 817 'name': 'str', 818 'promiscuous': 'bool', 819 'multicast': 'RxState', 820 'unicast': 'RxState', 821 'vlan': 'RxState', 822 'broadcast-allowed': 'bool', 823 'multicast-overflow': 'bool', 824 'unicast-overflow': 'bool', 825 'main-mac': 'str', 826 'vlan-table': ['int'], 827 'unicast-table': ['str'], 828 'multicast-table': ['str'] }} 829 830## 831# @query-rx-filter: 832# 833# Return rx-filter information for all NICs (or for the given NIC). 834# 835# @name: net client name 836# 837# Returns: list of @RxFilterInfo for all NICs (or for the given NIC). 838# 839# Errors: 840# - if the given @name doesn't exist 841# - if the given NIC doesn't support rx-filter querying 842# - if the given net client isn't a NIC 843# 844# Since: 1.6 845# 846# .. qmp-example:: 847# 848# -> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } } 849# <- { "return": [ 850# { 851# "promiscuous": true, 852# "name": "vnet0", 853# "main-mac": "52:54:00:12:34:56", 854# "unicast": "normal", 855# "vlan": "normal", 856# "vlan-table": [ 857# 4, 858# 0 859# ], 860# "unicast-table": [ 861# ], 862# "multicast": "normal", 863# "multicast-overflow": false, 864# "unicast-overflow": false, 865# "multicast-table": [ 866# "01:00:5e:00:00:01", 867# "33:33:00:00:00:01", 868# "33:33:ff:12:34:56" 869# ], 870# "broadcast-allowed": false 871# } 872# ] 873# } 874## 875{ 'command': 'query-rx-filter', 876 'data': { '*name': 'str' }, 877 'returns': ['RxFilterInfo'] } 878 879## 880# @NIC_RX_FILTER_CHANGED: 881# 882# Emitted once until the 'query-rx-filter' command is executed, the 883# first event will always be emitted 884# 885# @name: net client name 886# 887# @path: device path 888# 889# Since: 1.6 890# 891# .. qmp-example:: 892# 893# <- { "event": "NIC_RX_FILTER_CHANGED", 894# "data": { "name": "vnet0", 895# "path": "/machine/peripheral/vnet0/virtio-backend" }, 896# "timestamp": { "seconds": 1368697518, "microseconds": 326866 } } 897## 898{ 'event': 'NIC_RX_FILTER_CHANGED', 899 'data': { '*name': 'str', 'path': 'str' } } 900 901## 902# @AnnounceParameters: 903# 904# Parameters for self-announce timers 905# 906# @initial: Initial delay (in ms) before sending the first GARP/RARP 907# announcement 908# 909# @max: Maximum delay (in ms) between GARP/RARP announcement packets 910# 911# @rounds: Number of self-announcement attempts 912# 913# @step: Delay increase (in ms) after each self-announcement attempt 914# 915# @interfaces: An optional list of interface names, which restricts 916# the announcement to the listed interfaces. (Since 4.1) 917# 918# @id: A name to be used to identify an instance of announce-timers 919# and to allow it to modified later. Not for use as part of the 920# migration parameters. (Since 4.1) 921# 922# Since: 4.0 923## 924 925{ 'struct': 'AnnounceParameters', 926 'data': { 'initial': 'int', 927 'max': 'int', 928 'rounds': 'int', 929 'step': 'int', 930 '*interfaces': ['str'], 931 '*id' : 'str' } } 932 933## 934# @announce-self: 935# 936# Trigger generation of broadcast RARP frames to update network 937# switches. This can be useful when network bonds fail-over the 938# active slave. 939# 940# TODO: This line is a hack to separate the example from the body 941# 942# .. qmp-example:: 943# 944# -> { "execute": "announce-self", 945# "arguments": { 946# "initial": 50, "max": 550, "rounds": 10, "step": 50, 947# "interfaces": ["vn2", "vn3"], "id": "bob" } } 948# <- { "return": {} } 949# 950# Since: 4.0 951## 952{ 'command': 'announce-self', 'boxed': true, 953 'data' : 'AnnounceParameters'} 954 955## 956# @FAILOVER_NEGOTIATED: 957# 958# Emitted when VIRTIO_NET_F_STANDBY was enabled during feature 959# negotiation. Failover primary devices which were hidden (not 960# hotplugged when requested) before will now be hotplugged by the 961# virtio-net standby device. 962# 963# @device-id: QEMU device id of the unplugged device 964# 965# Since: 4.2 966# 967# .. qmp-example:: 968# 969# <- { "event": "FAILOVER_NEGOTIATED", 970# "data": { "device-id": "net1" }, 971# "timestamp": { "seconds": 1368697518, "microseconds": 326866 } } 972## 973{ 'event': 'FAILOVER_NEGOTIATED', 974 'data': {'device-id': 'str'} } 975 976## 977# @NETDEV_STREAM_CONNECTED: 978# 979# Emitted when the netdev stream backend is connected 980# 981# @netdev-id: QEMU netdev id that is connected 982# 983# @addr: The destination address 984# 985# Since: 7.2 986# 987# .. qmp-example:: 988# 989# <- { "event": "NETDEV_STREAM_CONNECTED", 990# "data": { "netdev-id": "netdev0", 991# "addr": { "port": "47666", "ipv6": true, 992# "host": "::1", "type": "inet" } }, 993# "timestamp": { "seconds": 1666269863, "microseconds": 311222 } } 994# 995# .. qmp-example:: 996# 997# <- { "event": "NETDEV_STREAM_CONNECTED", 998# "data": { "netdev-id": "netdev0", 999# "addr": { "path": "/tmp/qemu0", "type": "unix" } }, 1000# "timestamp": { "seconds": 1666269706, "microseconds": 413651 } } 1001## 1002{ 'event': 'NETDEV_STREAM_CONNECTED', 1003 'data': { 'netdev-id': 'str', 1004 'addr': 'SocketAddress' } } 1005 1006## 1007# @NETDEV_STREAM_DISCONNECTED: 1008# 1009# Emitted when the netdev stream backend is disconnected 1010# 1011# @netdev-id: QEMU netdev id that is disconnected 1012# 1013# Since: 7.2 1014# 1015# .. qmp-example:: 1016# 1017# <- { "event": "NETDEV_STREAM_DISCONNECTED", 1018# "data": {"netdev-id": "netdev0"}, 1019# "timestamp": {"seconds": 1663330937, "microseconds": 526695} } 1020## 1021{ 'event': 'NETDEV_STREAM_DISCONNECTED', 1022 'data': { 'netdev-id': 'str' } } 1023