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 # @NetdevNoneOptions:
  93 #
  94 # Use it alone to have zero network devices.
  95 #
  96 # Since: 1.2
  97 ##
  98 { 'struct': 'NetdevNoneOptions',
  99   'data': { } }
 100
 101 ##
 102 # @NetLegacyNicOptions:
 103 #
 104 # Create a new Network Interface Card.
 105 #
 106 # @netdev: id of -netdev to connect to
 107 #
 108 # @macaddr: MAC address
 109 #
 110 # @model: device model (e1000, rtl8139, virtio etc.)
 111 #
 112 # @addr: PCI device address
 113 #
 114 # @vectors: number of MSI-x vectors, 0 to disable MSI-X
 115 #
 116 # Since: 1.2
 117 ##
 118 { 'struct': 'NetLegacyNicOptions',
 119   'data': {
 120     '*netdev':  'str',
 121     '*macaddr': 'str',
 122     '*model':   'str',
 123     '*addr':    'str',
 124     '*vectors': 'uint32' } }
 125
 126 ##
 127 # @NetdevUserOptions:
 128 #
 129 # Use the user mode network stack which requires no administrator privilege to
 130 # run.
 131 #
 132 # @hostname: client hostname reported by the builtin DHCP server
 133 #
 134 # @restrict: isolate the guest from the host
 135 #
 136 # @ipv4: whether to support IPv4, default true for enabled
 137 #        (since 2.6)
 138 #
 139 # @ipv6: whether to support IPv6, default true for enabled
 140 #        (since 2.6)
 141 #
 142 # @ip: legacy parameter, use net= instead
 143 #
 144 # @net: IP network address that the guest will see, in the
 145 #       form addr[/netmask] The netmask is optional, and can be
 146 #       either in the form a.b.c.d or as a number of valid top-most
 147 #       bits. Default is 10.0.2.0/24.
 148 #
 149 # @host: guest-visible address of the host
 150 #
 151 # @tftp: root directory of the built-in TFTP server
 152 #
 153 # @bootfile: BOOTP filename, for use with tftp=
 154 #
 155 # @dhcpstart: the first of the 16 IPs the built-in DHCP server can
 156 #             assign
 157 #
 158 # @dns: guest-visible address of the virtual nameserver
 159 #
 160 # @dnssearch: list of DNS suffixes to search, passed as DHCP option
 161 #             to the guest
 162 #
 163 # @ipv6-prefix: IPv6 network prefix (default is fec0::) (since
 164 #               2.6). The network prefix is given in the usual
 165 #               hexadecimal IPv6 address notation.
 166 #
 167 # @ipv6-prefixlen: IPv6 network prefix length (default is 64)
 168 #                  (since 2.6)
 169 #
 170 # @ipv6-host: guest-visible IPv6 address of the host (since 2.6)
 171 #
 172 # @ipv6-dns: guest-visible IPv6 address of the virtual
 173 #            nameserver (since 2.6)
 174 #
 175 # @smb: root directory of the built-in SMB server
 176 #
 177 # @smbserver: IP address of the built-in SMB server
 178 #
 179 # @hostfwd: redirect incoming TCP or UDP host connections to guest
 180 #           endpoints
 181 #
 182 # @guestfwd: forward guest TCP connections
 183 #
 184 # Since: 1.2
 185 ##
 186 { 'struct': 'NetdevUserOptions',
 187   'data': {
 188     '*hostname':  'str',
 189     '*restrict':  'bool',
 190     '*ipv4':      'bool',
 191     '*ipv6':      'bool',
 192     '*ip':        'str',
 193     '*net':       'str',
 194     '*host':      'str',
 195     '*tftp':      'str',
 196     '*bootfile':  'str',
 197     '*dhcpstart': 'str',
 198     '*dns':       'str',
 199     '*dnssearch': ['String'],
 200     '*ipv6-prefix':      'str',
 201     '*ipv6-prefixlen':   'int',
 202     '*ipv6-host':        'str',
 203     '*ipv6-dns':         'str',
 204     '*smb':       'str',
 205     '*smbserver': 'str',
 206     '*hostfwd':   ['String'],
 207     '*guestfwd':  ['String'] } }
 208
 209 ##
 210 # @NetdevTapOptions:
 211 #
 212 # Used to configure a host TAP network interface backend.
 213 #
 214 # @ifname: interface name
 215 #
 216 # @fd: file descriptor of an already opened tap
 217 #
 218 # @fds: multiple file descriptors of already opened multiqueue capable
 219 # tap
 220 #
 221 # @script: script to initialize the interface
 222 #
 223 # @downscript: script to shut down the interface
 224 #
 225 # @br: bridge name (since 2.8)
 226 #
 227 # @helper: command to execute to configure bridge
 228 #
 229 # @sndbuf: send buffer limit. Understands [TGMKkb] suffixes.
 230 #
 231 # @vnet_hdr: enable the IFF_VNET_HDR flag on the tap interface
 232 #
 233 # @vhost: enable vhost-net network accelerator
 234 #
 235 # @vhostfd: file descriptor of an already opened vhost net device
 236 #
 237 # @vhostfds: file descriptors of multiple already opened vhost net
 238 # devices
 239 #
 240 # @vhostforce: vhost on for non-MSIX virtio guests
 241 #
 242 # @queues: number of queues to be created for multiqueue capable tap
 243 #
 244 # @poll-us: maximum number of microseconds that could
 245 # be spent on busy polling for tap (since 2.7)
 246 #
 247 # Since: 1.2
 248 ##
 249 { 'struct': 'NetdevTapOptions',
 250   'data': {
 251     '*ifname':     'str',
 252     '*fd':         'str',
 253     '*fds':        'str',
 254     '*script':     'str',
 255     '*downscript': 'str',
 256     '*br':         'str',
 257     '*helper':     'str',
 258     '*sndbuf':     'size',
 259     '*vnet_hdr':   'bool',
 260     '*vhost':      'bool',
 261     '*vhostfd':    'str',
 262     '*vhostfds':   'str',
 263     '*vhostforce': 'bool',
 264     '*queues':     'uint32',
 265     '*poll-us':    'uint32'} }
 266
 267 ##
 268 # @NetdevSocketOptions:
 269 #
 270 # Socket netdevs are used to establish a network connection to another
 271 # QEMU virtual machine via a TCP socket.
 272 #
 273 # @fd: file descriptor of an already opened socket
 274 #
 275 # @listen: port number, and optional hostname, to listen on
 276 #
 277 # @connect: port number, and optional hostname, to connect to
 278 #
 279 # @mcast: UDP multicast address and port number
 280 #
 281 # @localaddr: source address and port for multicast and udp packets
 282 #
 283 # @udp: UDP unicast address and port number
 284 #
 285 # Since: 1.2
 286 ##
 287 { 'struct': 'NetdevSocketOptions',
 288   'data': {
 289     '*fd':        'str',
 290     '*listen':    'str',
 291     '*connect':   'str',
 292     '*mcast':     'str',
 293     '*localaddr': 'str',
 294     '*udp':       'str' } }
 295
 296 ##
 297 # @NetdevL2TPv3Options:
 298 #
 299 # Configure an Ethernet over L2TPv3 tunnel.
 300 #
 301 # @src: source address
 302 #
 303 # @dst: destination address
 304 #
 305 # @srcport: source port - mandatory for udp, optional for ip
 306 #
 307 # @dstport: destination port - mandatory for udp, optional for ip
 308 #
 309 # @ipv6: force the use of ipv6
 310 #
 311 # @udp: use the udp version of l2tpv3 encapsulation
 312 #
 313 # @cookie64: use 64 bit coookies
 314 #
 315 # @counter: have sequence counter
 316 #
 317 # @pincounter: pin sequence counter to zero -
 318 #              workaround for buggy implementations or
 319 #              networks with packet reorder
 320 #
 321 # @txcookie: 32 or 64 bit transmit cookie
 322 #
 323 # @rxcookie: 32 or 64 bit receive cookie
 324 #
 325 # @txsession: 32 bit transmit session
 326 #
 327 # @rxsession: 32 bit receive session - if not specified
 328 #             set to the same value as transmit
 329 #
 330 # @offset: additional offset - allows the insertion of
 331 #          additional application-specific data before the packet payload
 332 #
 333 # Since: 2.1
 334 ##
 335 { 'struct': 'NetdevL2TPv3Options',
 336   'data': {
 337     'src':          'str',
 338     'dst':          'str',
 339     '*srcport':     'str',
 340     '*dstport':     'str',
 341     '*ipv6':        'bool',
 342     '*udp':         'bool',
 343     '*cookie64':    'bool',
 344     '*counter':     'bool',
 345     '*pincounter':  'bool',
 346     '*txcookie':    'uint64',
 347     '*rxcookie':    'uint64',
 348     'txsession':    'uint32',
 349     '*rxsession':   'uint32',
 350     '*offset':      'uint32' } }
 351
 352 ##
 353 # @NetdevVdeOptions:
 354 #
 355 # Connect to a vde switch running on the host.
 356 #
 357 # @sock: socket path
 358 #
 359 # @port: port number
 360 #
 361 # @group: group owner of socket
 362 #
 363 # @mode: permissions for socket
 364 #
 365 # Since: 1.2
 366 ##
 367 { 'struct': 'NetdevVdeOptions',
 368   'data': {
 369     '*sock':  'str',
 370     '*port':  'uint16',
 371     '*group': 'str',
 372     '*mode':  'uint16' } }
 373
 374 ##
 375 # @NetdevBridgeOptions:
 376 #
 377 # Connect a host TAP network interface to a host bridge device.
 378 #
 379 # @br: bridge name
 380 #
 381 # @helper: command to execute to configure bridge
 382 #
 383 # Since: 1.2
 384 ##
 385 { 'struct': 'NetdevBridgeOptions',
 386   'data': {
 387     '*br':     'str',
 388     '*helper': 'str' } }
 389
 390 ##
 391 # @NetdevHubPortOptions:
 392 #
 393 # Connect two or more net clients through a software hub.
 394 #
 395 # @hubid: hub identifier number
 396 # @netdev: used to connect hub to a netdev instead of a device (since 2.12)
 397 #
 398 # Since: 1.2
 399 ##
 400 { 'struct': 'NetdevHubPortOptions',
 401   'data': {
 402     'hubid':     'int32',
 403     '*netdev':    'str' } }
 404
 405 ##
 406 # @NetdevNetmapOptions:
 407 #
 408 # Connect a client to a netmap-enabled NIC or to a VALE switch port
 409 #
 410 # @ifname: Either the name of an existing network interface supported by
 411 #          netmap, or the name of a VALE port (created on the fly).
 412 #          A VALE port name is in the form 'valeXXX:YYY', where XXX and
 413 #          YYY are non-negative integers. XXX identifies a switch and
 414 #          YYY identifies a port of the switch. VALE ports having the
 415 #          same XXX are therefore connected to the same switch.
 416 #
 417 # @devname: path of the netmap device (default: '/dev/netmap').
 418 #
 419 # Since: 2.0
 420 ##
 421 { 'struct': 'NetdevNetmapOptions',
 422   'data': {
 423     'ifname':     'str',
 424     '*devname':    'str' } }
 425
 426 ##
 427 # @NetdevVhostUserOptions:
 428 #
 429 # Vhost-user network backend
 430 #
 431 # @chardev: name of a unix socket chardev
 432 #
 433 # @vhostforce: vhost on for non-MSIX virtio guests (default: false).
 434 #
 435 # @queues: number of queues to be created for multiqueue vhost-user
 436 #          (default: 1) (Since 2.5)
 437 #
 438 # Since: 2.1
 439 ##
 440 { 'struct': 'NetdevVhostUserOptions',
 441   'data': {
 442     'chardev':        'str',
 443     '*vhostforce':    'bool',
 444     '*queues':        'int' } }
 445
 446 ##
 447 # @NetClientDriver:
 448 #
 449 # Available netdev drivers.
 450 #
 451 # Since: 2.7
 452 #
 453 # 'dump': dropped in 2.12
 454 ##
 455 { 'enum': 'NetClientDriver',
 456   'data': [ 'none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'vde',
 457             'bridge', 'hubport', 'netmap', 'vhost-user' ] }
 458
 459 ##
 460 # @Netdev:
 461 #
 462 # Captures the configuration of a network device.
 463 #
 464 # @id: identifier for monitor commands.
 465 #
 466 # @type: Specify the driver used for interpreting remaining arguments.
 467 #
 468 # Since: 1.2
 469 #
 470 # 'l2tpv3' - since 2.1
 471 ##
 472 { 'union': 'Netdev',
 473   'base': { 'id': 'str', 'type': 'NetClientDriver' },
 474   'discriminator': 'type',
 475   'data': {
 476     'none':     'NetdevNoneOptions',
 477     'nic':      'NetLegacyNicOptions',
 478     'user':     'NetdevUserOptions',
 479     'tap':      'NetdevTapOptions',
 480     'l2tpv3':   'NetdevL2TPv3Options',
 481     'socket':   'NetdevSocketOptions',
 482     'vde':      'NetdevVdeOptions',
 483     'bridge':   'NetdevBridgeOptions',
 484     'hubport':  'NetdevHubPortOptions',
 485     'netmap':   'NetdevNetmapOptions',
 486     'vhost-user': 'NetdevVhostUserOptions' } }
 487
 488 ##
 489 # @NetLegacy:
 490 #
 491 # Captures the configuration of a network device; legacy.
 492 #
 493 # @id: identifier for monitor commands
 494 #
 495 # @name: identifier for monitor commands, ignored if @id is present
 496 #
 497 # @opts: device type specific properties (legacy)
 498 #
 499 # Since: 1.2
 500 #
 501 # 'vlan': dropped in 2.13
 502 ##
 503 { 'struct': 'NetLegacy',
 504   'data': {
 505     '*id':   'str',
 506     '*name': 'str',
 507     'opts':  'NetLegacyOptions' } }
 508
 509 ##
 510 # @NetLegacyOptionsType:
 511 #
 512 # Since: 1.2
 513 ##
 514 { 'enum': 'NetLegacyOptionsType',
 515   'data': ['none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'vde',
 516            'bridge', 'netmap', 'vhost-user'] }
 517
 518 ##
 519 # @NetLegacyOptions:
 520 #
 521 # Like Netdev, but for use only by the legacy command line options
 522 #
 523 # Since: 1.2
 524 ##
 525 { 'union': 'NetLegacyOptions',
 526   'base': { 'type': 'NetLegacyOptionsType' },
 527   'discriminator': 'type',
 528   'data': {
 529     'none':     'NetdevNoneOptions',
 530     'nic':      'NetLegacyNicOptions',
 531     'user':     'NetdevUserOptions',
 532     'tap':      'NetdevTapOptions',
 533     'l2tpv3':   'NetdevL2TPv3Options',
 534     'socket':   'NetdevSocketOptions',
 535     'vde':      'NetdevVdeOptions',
 536     'bridge':   'NetdevBridgeOptions',
 537     'netmap':   'NetdevNetmapOptions',
 538     'vhost-user': 'NetdevVhostUserOptions' } }
 539
 540 ##
 541 # @NetFilterDirection:
 542 #
 543 # Indicates whether a netfilter is attached to a netdev's transmit queue or
 544 # receive queue or both.
 545 #
 546 # @all: the filter is attached both to the receive and the transmit
 547 #       queue of the netdev (default).
 548 #
 549 # @rx: the filter is attached to the receive queue of the netdev,
 550 #      where it will receive packets sent to the netdev.
 551 #
 552 # @tx: the filter is attached to the transmit queue of the netdev,
 553 #      where it will receive packets sent by the netdev.
 554 #
 555 # Since: 2.5
 556 ##
 557 { 'enum': 'NetFilterDirection',
 558   'data': [ 'all', 'rx', 'tx' ] }
 559
 560 ##
 561 # @RxState:
 562 #
 563 # Packets receiving state
 564 #
 565 # @normal: filter assigned packets according to the mac-table
 566 #
 567 # @none: don't receive any assigned packet
 568 #
 569 # @all: receive all assigned packets
 570 #
 571 # Since: 1.6
 572 ##
 573 { 'enum': 'RxState', 'data': [ 'normal', 'none', 'all' ] }
 574
 575 ##
 576 # @RxFilterInfo:
 577 #
 578 # Rx-filter information for a NIC.
 579 #
 580 # @name: net client name
 581 #
 582 # @promiscuous: whether promiscuous mode is enabled
 583 #
 584 # @multicast: multicast receive state
 585 #
 586 # @unicast: unicast receive state
 587 #
 588 # @vlan: vlan receive state (Since 2.0)
 589 #
 590 # @broadcast-allowed: whether to receive broadcast
 591 #
 592 # @multicast-overflow: multicast table is overflowed or not
 593 #
 594 # @unicast-overflow: unicast table is overflowed or not
 595 #
 596 # @main-mac: the main macaddr string
 597 #
 598 # @vlan-table: a list of active vlan id
 599 #
 600 # @unicast-table: a list of unicast macaddr string
 601 #
 602 # @multicast-table: a list of multicast macaddr string
 603 #
 604 # Since: 1.6
 605 ##
 606 { 'struct': 'RxFilterInfo',
 607   'data': {
 608     'name':               'str',
 609     'promiscuous':        'bool',
 610     'multicast':          'RxState',
 611     'unicast':            'RxState',
 612     'vlan':               'RxState',
 613     'broadcast-allowed':  'bool',
 614     'multicast-overflow': 'bool',
 615     'unicast-overflow':   'bool',
 616     'main-mac':           'str',
 617     'vlan-table':         ['int'],
 618     'unicast-table':      ['str'],
 619     'multicast-table':    ['str'] }}
 620
 621 ##
 622 # @query-rx-filter:
 623 #
 624 # Return rx-filter information for all NICs (or for the given NIC).
 625 #
 626 # @name: net client name
 627 #
 628 # Returns: list of @RxFilterInfo for all NICs (or for the given NIC).
 629 #          Returns an error if the given @name doesn't exist, or given
 630 #          NIC doesn't support rx-filter querying, or given net client
 631 #          isn't a NIC.
 632 #
 633 # Since: 1.6
 634 #
 635 # Example:
 636 #
 637 # -> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
 638 # <- { "return": [
 639 #         {
 640 #             "promiscuous": true,
 641 #             "name": "vnet0",
 642 #             "main-mac": "52:54:00:12:34:56",
 643 #             "unicast": "normal",
 644 #             "vlan": "normal",
 645 #             "vlan-table": [
 646 #                 4,
 647 #                 0
 648 #             ],
 649 #             "unicast-table": [
 650 #             ],
 651 #             "multicast": "normal",
 652 #             "multicast-overflow": false,
 653 #             "unicast-overflow": false,
 654 #             "multicast-table": [
 655 #                 "01:00:5e:00:00:01",
 656 #                 "33:33:00:00:00:01",
 657 #                 "33:33:ff:12:34:56"
 658 #             ],
 659 #             "broadcast-allowed": false
 660 #         }
 661 #       ]
 662 #    }
 663 #
 664 ##
 665 { 'command': 'query-rx-filter', 'data': { '*name': 'str' },
 666   'returns': ['RxFilterInfo'] }
 667
 668 ##
 669 # @NIC_RX_FILTER_CHANGED:
 670 #
 671 # Emitted once until the 'query-rx-filter' command is executed, the first event
 672 # will always be emitted
 673 #
 674 # @name: net client name
 675 #
 676 # @path: device path
 677 #
 678 # Since: 1.6
 679 #
 680 # Example:
 681 #
 682 # <- { "event": "NIC_RX_FILTER_CHANGED",
 683 #      "data": { "name": "vnet0",
 684 #                "path": "/machine/peripheral/vnet0/virtio-backend" },
 685 #      "timestamp": { "seconds": 1368697518, "microseconds": 326866 } }
 686 #    }
 687 #
 688 ##
 689 { 'event': 'NIC_RX_FILTER_CHANGED',
 690   'data': { '*name': 'str', 'path': 'str' } }