qemu/qapi/char.json

1 # -*- Mode: Python -*-
20 # @frontend-open: shows whether the frontend device attached to this
32             'frontend-open': 'bool' } }
35 # @query-chardev:
43 # .. qmp-example::
45 #     -> { "execute": "query-chardev" }
46 #     <- {
50 #                 "filename": "unix:/var/lib/libvirt/qemu/seabios.rhel6.agent,server=on",
51 #                 "frontend-open": false
56 #                 "frontend-open": true
61 #                 "frontend-open": true
66 { 'command': 'query-chardev', 'returns': ['ChardevInfo'],
67   'allow-preconfig': true }
81 # @query-chardev-backends:
89 # .. qmp-example::
91 #     -> { "execute": "query-chardev-backends" }
92 #     <- {
109 { 'command': 'query-chardev-backends', 'returns': ['ChardevBackendInfo'] }
116 # @utf8: Data is a UTF-8 string (RFC 3629)
126 # @ringbuf-write:
136 #     - base64: data must be base64 encoded text.  Its binary decoding
138 #     - utf8: data's UTF-8 encoding is written
139 #     - data itself is always Unicode regardless of format, like any
144 # .. qmp-example::
146 #     -> { "execute": "ringbuf-write",
150 #     <- { "return": {} }
152 { 'command': 'ringbuf-write',
158 # @ringbuf-read:
168 #     - base64: the data read is returned in base64 encoding.
169 #     - utf8: the data read is interpreted as UTF-8.
170 #       Bug: can screw up when the buffer contains invalid UTF-8
173 #     - The return value is always Unicode regardless of format, like
180 # .. qmp-example::
182 #     -> { "execute": "ringbuf-read",
186 #     <- { "return": "abcdefgh" }
188 { 'command': 'ringbuf-read',
250 # @tls-creds: the ID of the TLS credentials object (since 2.6)
252 # @tls-authz: the ID of the QAuthZ authorization object against which
277 #     deprecated, use @reconnect-ms instead.  (default: 0) (Since: 2.2)
279 # @reconnect-ms: For a client socket, if a socket is disconnected,
287 # @deprecated: Member @reconnect is deprecated.  Use @reconnect-ms
294             '*tls-creds': 'str',
295             '*tls-authz'  : 'str',
303             '*reconnect-ms': 'int' },
381 # @fqdn: name of the channel (see docs/spice-port-fqdn.txt)
395 # @name: name of the channel (following docs/spice-port-fqdn.txt)
419 #    GTK, Spice, VNC and D-Bus display backends.
448 # @mouse: enable/disable mouse, default is enabled.
450 # @clipboard: enable/disable clipboard, default is disabled.
489 # @pty: pseudo-terminal
503 # @testdev: device for test-suite control (since 2.2)
513 # @qemu-vdagent: Spice vdagent (since 6.1)
515 # @dbus: D-Bus channel (since 7.0)
548             { 'name': 'qemu-vdagent', 'if': 'CONFIG_SPICE_PROTOCOL' },
745             'qemu-vdagent': { 'type': 'ChardevQemuVDAgentWrapper',
767 # @chardev-add:
779 # .. qmp-example::
781 #     -> { "execute" : "chardev-add",
784 #     <- { "return": {} }
786 # .. qmp-example::
788 #     -> { "execute" : "chardev-add",
792 #     <- { "return": {} }
794 # .. qmp-example::
796 #     -> { "execute" : "chardev-add",
799 #     <- { "return": { "pty" : "/dev/pty/42" } }
801 { 'command': 'chardev-add',
807 # @chardev-change:
819 # .. qmp-example::
821 #     -> { "execute" : "chardev-change",
824 #     <- { "return": { "pty" : "/dev/pty/42" } }
826 # .. qmp-example::
828 #     -> {"execute" : "chardev-change",
842 #     <- {"return": {}}
844 { 'command': 'chardev-change',
850 # @chardev-remove:
858 # .. qmp-example::
860 #     -> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
861 #     <- { "return": {} }
863 { 'command': 'chardev-remove',
867 # @chardev-send-break:
875 # .. qmp-example::
877 #     -> { "execute": "chardev-send-break", "arguments": { "id" : "foo" } }
878 #     <- { "return": {} }
880 { 'command': 'chardev-send-break',
886 # Emitted when the guest opens or closes a virtio-serial port.
888 # @id: device identifier of the virtio-serial port
890 # @open: true if the guest has opened the virtio-serial port
892 # .. note:: This event is rate-limited.
896 # .. qmp-example::
898 #     <- { "event": "VSERPORT_CHANGE",