smbus-eeprom: remove PROP_PTR
[qemu/ar7.git] / qga / qapi-schema.json
blobfb4605cc19c181527f135db5ff6f15ee981fc640
1 # *-*- Mode: Python -*-*
3 ##
5 # General note concerning the use of guest agent interfaces:
7 # "unsupported" is a higher-level error than the errors that individual
8 # commands might document. The caller should always be prepared to receive
9 # QERR_UNSUPPORTED, even if the given command doesn't specify it, or doesn't
10 # document any failure mode at all.
14 { 'pragma': { 'doc-required': true } }
16 # Whitelists to permit QAPI rule violations; think twice before you
17 # add to them!
18 { 'pragma': {
19     # Commands allowed to return a non-dictionary:
20     'returns-whitelist': [
21         'guest-file-open',
22         'guest-fsfreeze-freeze',
23         'guest-fsfreeze-freeze-list',
24         'guest-fsfreeze-status',
25         'guest-fsfreeze-thaw',
26         'guest-get-time',
27         'guest-set-vcpus',
28         'guest-sync',
29         'guest-sync-delimited' ] } }
32 # @guest-sync-delimited:
34 # Echo back a unique integer value, and prepend to response a
35 # leading sentinel byte (0xFF) the client can check scan for.
37 # This is used by clients talking to the guest agent over the
38 # wire to ensure the stream is in sync and doesn't contain stale
39 # data from previous client. It must be issued upon initial
40 # connection, and after any client-side timeouts (including
41 # timeouts on receiving a response to this command).
43 # After issuing this request, all guest agent responses should be
44 # ignored until the response containing the unique integer value
45 # the client passed in is returned. Receival of the 0xFF sentinel
46 # byte must be handled as an indication that the client's
47 # lexer/tokenizer/parser state should be flushed/reset in
48 # preparation for reliably receiving the subsequent response. As
49 # an optimization, clients may opt to ignore all data until a
50 # sentinel value is receiving to avoid unnecessary processing of
51 # stale data.
53 # Similarly, clients should also precede this *request*
54 # with a 0xFF byte to make sure the guest agent flushes any
55 # partially read JSON data from a previous client connection.
57 # @id: randomly generated 64-bit integer
59 # Returns: The unique integer id passed in by the client
61 # Since: 1.1
63 { 'command': 'guest-sync-delimited',
64   'data':    { 'id': 'int' },
65   'returns': 'int' }
68 # @guest-sync:
70 # Echo back a unique integer value
72 # This is used by clients talking to the guest agent over the
73 # wire to ensure the stream is in sync and doesn't contain stale
74 # data from previous client. All guest agent responses should be
75 # ignored until the provided unique integer value is returned,
76 # and it is up to the client to handle stale whole or
77 # partially-delivered JSON text in such a way that this response
78 # can be obtained.
80 # In cases where a partial stale response was previously
81 # received by the client, this cannot always be done reliably.
82 # One particular scenario being if qemu-ga responses are fed
83 # character-by-character into a JSON parser. In these situations,
84 # using guest-sync-delimited may be optimal.
86 # For clients that fetch responses line by line and convert them
87 # to JSON objects, guest-sync should be sufficient, but note that
88 # in cases where the channel is dirty some attempts at parsing the
89 # response may result in a parser error.
91 # Such clients should also precede this command
92 # with a 0xFF byte to make sure the guest agent flushes any
93 # partially read JSON data from a previous session.
95 # @id: randomly generated 64-bit integer
97 # Returns: The unique integer id passed in by the client
99 # Since: 0.15.0
101 { 'command': 'guest-sync',
102   'data':    { 'id': 'int' },
103   'returns': 'int' }
106 # @guest-ping:
108 # Ping the guest agent, a non-error return implies success
110 # Since: 0.15.0
112 { 'command': 'guest-ping' }
115 # @guest-get-time:
117 # Get the information about guest's System Time relative to
118 # the Epoch of 1970-01-01 in UTC.
120 # Returns: Time in nanoseconds.
122 # Since: 1.5
124 { 'command': 'guest-get-time',
125   'returns': 'int' }
128 # @guest-set-time:
130 # Set guest time.
132 # When a guest is paused or migrated to a file then loaded
133 # from that file, the guest OS has no idea that there
134 # was a big gap in the time. Depending on how long the
135 # gap was, NTP might not be able to resynchronize the
136 # guest.
138 # This command tries to set guest's System Time to the
139 # given value, then sets the Hardware Clock (RTC) to the
140 # current System Time. This will make it easier for a guest
141 # to resynchronize without waiting for NTP. If no @time is
142 # specified, then the time to set is read from RTC. However,
143 # this may not be supported on all platforms (i.e. Windows).
144 # If that's the case users are advised to always pass a
145 # value.
147 # @time: time of nanoseconds, relative to the Epoch
148 #        of 1970-01-01 in UTC.
150 # Returns: Nothing on success.
152 # Since: 1.5
154 { 'command': 'guest-set-time',
155   'data': { '*time': 'int' } }
158 # @GuestAgentCommandInfo:
160 # Information about guest agent commands.
162 # @name: name of the command
164 # @enabled: whether command is currently enabled by guest admin
166 # @success-response: whether command returns a response on success
167 #                    (since 1.7)
169 # Since: 1.1.0
171 { 'struct': 'GuestAgentCommandInfo',
172   'data': { 'name': 'str', 'enabled': 'bool', 'success-response': 'bool' } }
175 # @GuestAgentInfo:
177 # Information about guest agent.
179 # @version: guest agent version
181 # @supported_commands: Information about guest agent commands
183 # Since: 0.15.0
185 { 'struct': 'GuestAgentInfo',
186   'data': { 'version': 'str',
187             'supported_commands': ['GuestAgentCommandInfo'] } }
189 # @guest-info:
191 # Get some information about the guest agent.
193 # Returns: @GuestAgentInfo
195 # Since: 0.15.0
197 { 'command': 'guest-info',
198   'returns': 'GuestAgentInfo' }
201 # @guest-shutdown:
203 # Initiate guest-activated shutdown. Note: this is an asynchronous
204 # shutdown request, with no guarantee of successful shutdown.
206 # @mode: "halt", "powerdown" (default), or "reboot"
208 # This command does NOT return a response on success. Success condition
209 # is indicated by the VM exiting with a zero exit status or, when
210 # running with --no-shutdown, by issuing the query-status QMP command
211 # to confirm the VM status is "shutdown".
213 # Since: 0.15.0
215 { 'command': 'guest-shutdown', 'data': { '*mode': 'str' },
216   'success-response': false }
219 # @guest-file-open:
221 # Open a file in the guest and retrieve a file handle for it
223 # @path: Full path to the file in the guest to open.
225 # @mode: open mode, as per fopen(), "r" is the default.
227 # Returns: Guest file handle on success.
229 # Since: 0.15.0
231 { 'command': 'guest-file-open',
232   'data':    { 'path': 'str', '*mode': 'str' },
233   'returns': 'int' }
236 # @guest-file-close:
238 # Close an open file in the guest
240 # @handle: filehandle returned by guest-file-open
242 # Returns: Nothing on success.
244 # Since: 0.15.0
246 { 'command': 'guest-file-close',
247   'data': { 'handle': 'int' } }
250 # @GuestFileRead:
252 # Result of guest agent file-read operation
254 # @count: number of bytes read (note: count is *before*
255 #         base64-encoding is applied)
257 # @buf-b64: base64-encoded bytes read
259 # @eof: whether EOF was encountered during read operation.
261 # Since: 0.15.0
263 { 'struct': 'GuestFileRead',
264   'data': { 'count': 'int', 'buf-b64': 'str', 'eof': 'bool' } }
267 # @guest-file-read:
269 # Read from an open file in the guest. Data will be base64-encoded
271 # @handle: filehandle returned by guest-file-open
273 # @count: maximum number of bytes to read (default is 4KB)
275 # Returns: @GuestFileRead on success.
277 # Since: 0.15.0
279 { 'command': 'guest-file-read',
280   'data':    { 'handle': 'int', '*count': 'int' },
281   'returns': 'GuestFileRead' }
284 # @GuestFileWrite:
286 # Result of guest agent file-write operation
288 # @count: number of bytes written (note: count is actual bytes
289 #         written, after base64-decoding of provided buffer)
291 # @eof: whether EOF was encountered during write operation.
293 # Since: 0.15.0
295 { 'struct': 'GuestFileWrite',
296   'data': { 'count': 'int', 'eof': 'bool' } }
299 # @guest-file-write:
301 # Write to an open file in the guest.
303 # @handle: filehandle returned by guest-file-open
305 # @buf-b64: base64-encoded string representing data to be written
307 # @count: bytes to write (actual bytes, after base64-decode),
308 #         default is all content in buf-b64 buffer after base64 decoding
310 # Returns: @GuestFileWrite on success.
312 # Since: 0.15.0
314 { 'command': 'guest-file-write',
315   'data':    { 'handle': 'int', 'buf-b64': 'str', '*count': 'int' },
316   'returns': 'GuestFileWrite' }
320 # @GuestFileSeek:
322 # Result of guest agent file-seek operation
324 # @position: current file position
326 # @eof: whether EOF was encountered during file seek
328 # Since: 0.15.0
330 { 'struct': 'GuestFileSeek',
331   'data': { 'position': 'int', 'eof': 'bool' } }
334 # @QGASeek:
336 # Symbolic names for use in @guest-file-seek
338 # @set: Set to the specified offset (same effect as 'whence':0)
339 # @cur: Add offset to the current location (same effect as 'whence':1)
340 # @end: Add offset to the end of the file (same effect as 'whence':2)
342 # Since: 2.6
344 { 'enum': 'QGASeek', 'data': [ 'set', 'cur', 'end' ] }
347 # @GuestFileWhence:
349 # Controls the meaning of offset to @guest-file-seek.
351 # @value: Integral value (0 for set, 1 for cur, 2 for end), available
352 #         for historical reasons, and might differ from the host's or
353 #         guest's SEEK_* values (since: 0.15)
354 # @name: Symbolic name, and preferred interface
356 # Since: 2.6
358 { 'alternate': 'GuestFileWhence',
359   'data': { 'value': 'int', 'name': 'QGASeek' } }
362 # @guest-file-seek:
364 # Seek to a position in the file, as with fseek(), and return the
365 # current file position afterward. Also encapsulates ftell()'s
366 # functionality, with offset=0 and whence=1.
368 # @handle: filehandle returned by guest-file-open
370 # @offset: bytes to skip over in the file stream
372 # @whence: Symbolic or numeric code for interpreting offset
374 # Returns: @GuestFileSeek on success.
376 # Since: 0.15.0
378 { 'command': 'guest-file-seek',
379   'data':    { 'handle': 'int', 'offset': 'int',
380                'whence': 'GuestFileWhence' },
381   'returns': 'GuestFileSeek' }
384 # @guest-file-flush:
386 # Write file changes bufferred in userspace to disk/kernel buffers
388 # @handle: filehandle returned by guest-file-open
390 # Returns: Nothing on success.
392 # Since: 0.15.0
394 { 'command': 'guest-file-flush',
395   'data': { 'handle': 'int' } }
398 # @GuestFsfreezeStatus:
400 # An enumeration of filesystem freeze states
402 # @thawed: filesystems thawed/unfrozen
404 # @frozen: all non-network guest filesystems frozen
406 # Since: 0.15.0
408 { 'enum': 'GuestFsfreezeStatus',
409   'data': [ 'thawed', 'frozen' ] }
412 # @guest-fsfreeze-status:
414 # Get guest fsfreeze state. error state indicates
416 # Returns: GuestFsfreezeStatus ("thawed", "frozen", etc., as defined below)
418 # Note: This may fail to properly report the current state as a result of
419 # some other guest processes having issued an fs freeze/thaw.
421 # Since: 0.15.0
423 { 'command': 'guest-fsfreeze-status',
424   'returns': 'GuestFsfreezeStatus' }
427 # @guest-fsfreeze-freeze:
429 # Sync and freeze all freezable, local guest filesystems. If this
430 # command succeeded, you may call @guest-fsfreeze-thaw later to
431 # unfreeze.
433 # Note: On Windows, the command is implemented with the help of a
434 # Volume Shadow-copy Service DLL helper. The frozen state is limited
435 # for up to 10 seconds by VSS.
437 # Returns: Number of file systems currently frozen. On error, all filesystems
438 # will be thawed. If no filesystems are frozen as a result of this call,
439 # then @guest-fsfreeze-status will remain "thawed" and calling
440 # @guest-fsfreeze-thaw is not necessary.
442 # Since: 0.15.0
444 { 'command': 'guest-fsfreeze-freeze',
445   'returns': 'int' }
448 # @guest-fsfreeze-freeze-list:
450 # Sync and freeze specified guest filesystems.
451 # See also @guest-fsfreeze-freeze.
453 # @mountpoints: an array of mountpoints of filesystems to be frozen.
454 #               If omitted, every mounted filesystem is frozen.
455 #               Invalid mount points are ignored.
457 # Returns: Number of file systems currently frozen. On error, all filesystems
458 # will be thawed.
460 # Since: 2.2
462 { 'command': 'guest-fsfreeze-freeze-list',
463   'data':    { '*mountpoints': ['str'] },
464   'returns': 'int' }
467 # @guest-fsfreeze-thaw:
469 # Unfreeze all frozen guest filesystems
471 # Returns: Number of file systems thawed by this call
473 # Note: if return value does not match the previous call to
474 #       guest-fsfreeze-freeze, this likely means some freezable
475 #       filesystems were unfrozen before this call, and that the
476 #       filesystem state may have changed before issuing this
477 #       command.
479 # Since: 0.15.0
481 { 'command': 'guest-fsfreeze-thaw',
482   'returns': 'int' }
485 # @GuestFilesystemTrimResult:
487 # @path: path that was trimmed
488 # @error: an error message when trim failed
489 # @trimmed: bytes trimmed for this path
490 # @minimum: reported effective minimum for this path
492 # Since: 2.4
494 { 'struct': 'GuestFilesystemTrimResult',
495   'data': {'path': 'str',
496            '*trimmed': 'int', '*minimum': 'int', '*error': 'str'} }
499 # @GuestFilesystemTrimResponse:
501 # @paths: list of @GuestFilesystemTrimResult per path that was trimmed
503 # Since: 2.4
505 { 'struct': 'GuestFilesystemTrimResponse',
506   'data': {'paths': ['GuestFilesystemTrimResult']} }
509 # @guest-fstrim:
511 # Discard (or "trim") blocks which are not in use by the filesystem.
513 # @minimum:
514 #       Minimum contiguous free range to discard, in bytes. Free ranges
515 #       smaller than this may be ignored (this is a hint and the guest
516 #       may not respect it).  By increasing this value, the fstrim
517 #       operation will complete more quickly for filesystems with badly
518 #       fragmented free space, although not all blocks will be discarded.
519 #       The default value is zero, meaning "discard every free block".
521 # Returns: A @GuestFilesystemTrimResponse which contains the
522 #          status of all trimmed paths. (since 2.4)
524 # Since: 1.2
526 { 'command': 'guest-fstrim',
527   'data': { '*minimum': 'int' },
528   'returns': 'GuestFilesystemTrimResponse' }
531 # @guest-suspend-disk:
533 # Suspend guest to disk.
535 # This command attempts to suspend the guest using three strategies, in this
536 # order:
538 # - systemd hibernate
539 # - pm-utils (via pm-hibernate)
540 # - manual write into sysfs
542 # This command does NOT return a response on success. There is a high chance
543 # the command succeeded if the VM exits with a zero exit status or, when
544 # running with --no-shutdown, by issuing the query-status QMP command to
545 # to confirm the VM status is "shutdown". However, the VM could also exit
546 # (or set its status to "shutdown") due to other reasons.
548 # The following errors may be returned:
549 #          If suspend to disk is not supported, Unsupported
551 # Notes: It's strongly recommended to issue the guest-sync command before
552 #        sending commands when the guest resumes
554 # Since: 1.1
556 { 'command': 'guest-suspend-disk', 'success-response': false }
559 # @guest-suspend-ram:
561 # Suspend guest to ram.
563 # This command attempts to suspend the guest using three strategies, in this
564 # order:
566 # - systemd suspend
567 # - pm-utils (via pm-suspend)
568 # - manual write into sysfs
570 # IMPORTANT: guest-suspend-ram requires working wakeup support in
571 # QEMU. You should check QMP command query-current-machine returns
572 # wakeup-suspend-support: true before issuing this command. Failure in
573 # doing so can result in a suspended guest that QEMU will not be able to
574 # awaken, forcing the user to power cycle the guest to bring it back.
576 # This command does NOT return a response on success. There are two options
577 # to check for success:
578 #   1. Wait for the SUSPEND QMP event from QEMU
579 #   2. Issue the query-status QMP command to confirm the VM status is
580 #      "suspended"
582 # The following errors may be returned:
583 #          If suspend to ram is not supported, Unsupported
585 # Notes: It's strongly recommended to issue the guest-sync command before
586 #        sending commands when the guest resumes
588 # Since: 1.1
590 { 'command': 'guest-suspend-ram', 'success-response': false }
593 # @guest-suspend-hybrid:
595 # Save guest state to disk and suspend to ram.
597 # This command attempts to suspend the guest by executing, in this order:
599 # - systemd hybrid-sleep
600 # - pm-utils (via pm-suspend-hybrid)
602 # IMPORTANT: guest-suspend-hybrid requires working wakeup support in
603 # QEMU. You should check QMP command query-current-machine returns
604 # wakeup-suspend-support: true before issuing this command. Failure in
605 # doing so can result in a suspended guest that QEMU will not be able to
606 # awaken, forcing the user to power cycle the guest to bring it back.
608 # This command does NOT return a response on success. There are two options
609 # to check for success:
610 #   1. Wait for the SUSPEND QMP event from QEMU
611 #   2. Issue the query-status QMP command to confirm the VM status is
612 #      "suspended"
614 # The following errors may be returned:
615 #          If hybrid suspend is not supported, Unsupported
617 # Notes: It's strongly recommended to issue the guest-sync command before
618 #        sending commands when the guest resumes
620 # Since: 1.1
622 { 'command': 'guest-suspend-hybrid', 'success-response': false }
625 # @GuestIpAddressType:
627 # An enumeration of supported IP address types
629 # @ipv4: IP version 4
631 # @ipv6: IP version 6
633 # Since: 1.1
635 { 'enum': 'GuestIpAddressType',
636   'data': [ 'ipv4', 'ipv6' ] }
639 # @GuestIpAddress:
641 # @ip-address: IP address
643 # @ip-address-type: Type of @ip-address (e.g. ipv4, ipv6)
645 # @prefix: Network prefix length of @ip-address
647 # Since: 1.1
649 { 'struct': 'GuestIpAddress',
650   'data': {'ip-address': 'str',
651            'ip-address-type': 'GuestIpAddressType',
652            'prefix': 'int'} }
655 # @GuestNetworkInterfaceStat:
657 # @rx-bytes: total bytes received
659 # @rx-packets: total packets received
661 # @rx-errs: bad packets received
663 # @rx-dropped: receiver dropped packets
665 # @tx-bytes: total bytes transmitted
667 # @tx-packets: total packets transmitted
669 # @tx-errs: packet transmit problems
671 # @tx-dropped: dropped packets transmitted
673 # Since: 2.11
675 { 'struct': 'GuestNetworkInterfaceStat',
676   'data': {'rx-bytes': 'uint64',
677             'rx-packets': 'uint64',
678             'rx-errs': 'uint64',
679             'rx-dropped': 'uint64',
680             'tx-bytes': 'uint64',
681             'tx-packets': 'uint64',
682             'tx-errs': 'uint64',
683             'tx-dropped': 'uint64'
684            } }
687 # @GuestNetworkInterface:
689 # @name: The name of interface for which info are being delivered
691 # @hardware-address: Hardware address of @name
693 # @ip-addresses: List of addresses assigned to @name
695 # @statistics: various statistic counters related to @name
696 # (since 2.11)
698 # Since: 1.1
700 { 'struct': 'GuestNetworkInterface',
701   'data': {'name': 'str',
702            '*hardware-address': 'str',
703            '*ip-addresses': ['GuestIpAddress'],
704            '*statistics': 'GuestNetworkInterfaceStat' } }
707 # @guest-network-get-interfaces:
709 # Get list of guest IP addresses, MAC addresses
710 # and netmasks.
712 # Returns: List of GuestNetworkInfo on success.
714 # Since: 1.1
716 { 'command': 'guest-network-get-interfaces',
717   'returns': ['GuestNetworkInterface'] }
720 # @GuestLogicalProcessor:
722 # @logical-id: Arbitrary guest-specific unique identifier of the VCPU.
724 # @online: Whether the VCPU is enabled.
726 # @can-offline: Whether offlining the VCPU is possible. This member
727 #               is always filled in by the guest agent when the structure is
728 #               returned, and always ignored on input (hence it can be omitted
729 #               then).
731 # Since: 1.5
733 { 'struct': 'GuestLogicalProcessor',
734   'data': {'logical-id': 'int',
735            'online': 'bool',
736            '*can-offline': 'bool'} }
739 # @guest-get-vcpus:
741 # Retrieve the list of the guest's logical processors.
743 # This is a read-only operation.
745 # Returns: The list of all VCPUs the guest knows about. Each VCPU is put on the
746 # list exactly once, but their order is unspecified.
748 # Since: 1.5
750 { 'command': 'guest-get-vcpus',
751   'returns': ['GuestLogicalProcessor'] }
754 # @guest-set-vcpus:
756 # Attempt to reconfigure (currently: enable/disable) logical processors inside
757 # the guest.
759 # The input list is processed node by node in order. In each node @logical-id
760 # is used to look up the guest VCPU, for which @online specifies the requested
761 # state. The set of distinct @logical-id's is only required to be a subset of
762 # the guest-supported identifiers. There's no restriction on list length or on
763 # repeating the same @logical-id (with possibly different @online field).
764 # Preferably the input list should describe a modified subset of
765 # @guest-get-vcpus' return value.
767 # Returns: The length of the initial sublist that has been successfully
768 #          processed. The guest agent maximizes this value. Possible cases:
770 #          - 0:              if the @vcpus list was empty on input. Guest state
771 #                            has not been changed. Otherwise,
772 #          - Error:          processing the first node of @vcpus failed for the
773 #                            reason returned. Guest state has not been changed.
774 #                            Otherwise,
775 #          - < length(@vcpus): more than zero initial nodes have been processed,
776 #                            but not the entire @vcpus list. Guest state has
777 #                            changed accordingly. To retrieve the error
778 #                            (assuming it persists), repeat the call with the
779 #                            successfully processed initial sublist removed.
780 #                            Otherwise,
781 #          - length(@vcpus): call successful.
783 # Since: 1.5
785 { 'command': 'guest-set-vcpus',
786   'data':    {'vcpus': ['GuestLogicalProcessor'] },
787   'returns': 'int' }
790 # @GuestDiskBusType:
792 # An enumeration of bus type of disks
794 # @ide: IDE disks
795 # @fdc: floppy disks
796 # @scsi: SCSI disks
797 # @virtio: virtio disks
798 # @xen: Xen disks
799 # @usb: USB disks
800 # @uml: UML disks
801 # @sata: SATA disks
802 # @sd: SD cards
803 # @unknown: Unknown bus type
804 # @ieee1394: Win IEEE 1394 bus type
805 # @ssa: Win SSA bus type
806 # @fibre: Win fiber channel bus type
807 # @raid: Win RAID bus type
808 # @iscsi: Win iScsi bus type
809 # @sas: Win serial-attaches SCSI bus type
810 # @mmc: Win multimedia card (MMC) bus type
811 # @virtual: Win virtual bus type
812 # @file-backed virtual: Win file-backed bus type
814 # Since: 2.2; 'Unknown' and all entries below since 2.4
816 { 'enum': 'GuestDiskBusType',
817   'data': [ 'ide', 'fdc', 'scsi', 'virtio', 'xen', 'usb', 'uml', 'sata',
818             'sd', 'unknown', 'ieee1394', 'ssa', 'fibre', 'raid', 'iscsi',
819             'sas', 'mmc', 'virtual', 'file-backed-virtual' ] }
823 # @GuestPCIAddress:
825 # @domain: domain id
826 # @bus: bus id
827 # @slot: slot id
828 # @function: function id
830 # Since: 2.2
832 { 'struct': 'GuestPCIAddress',
833   'data': {'domain': 'int', 'bus': 'int',
834            'slot': 'int', 'function': 'int'} }
837 # @GuestDiskAddress:
839 # @pci-controller: controller's PCI address
840 # @bus-type: bus type
841 # @bus: bus id
842 # @target: target id
843 # @unit: unit id
844 # @serial: serial number (since: 3.1)
845 # @dev: device node (POSIX) or device UNC (Windows) (since: 3.1)
847 # Since: 2.2
849 { 'struct': 'GuestDiskAddress',
850   'data': {'pci-controller': 'GuestPCIAddress',
851            'bus-type': 'GuestDiskBusType',
852            'bus': 'int', 'target': 'int', 'unit': 'int',
853            '*serial': 'str', '*dev': 'str'} }
856 # @GuestFilesystemInfo:
858 # @name: disk name
859 # @mountpoint: mount point path
860 # @type: file system type string
861 # @used-bytes: file system used bytes (since 3.0)
862 # @total-bytes: non-root file system total bytes (since 3.0)
863 # @disk: an array of disk hardware information that the volume lies on,
864 #        which may be empty if the disk type is not supported
866 # Since: 2.2
868 { 'struct': 'GuestFilesystemInfo',
869   'data': {'name': 'str', 'mountpoint': 'str', 'type': 'str',
870            '*used-bytes': 'uint64', '*total-bytes': 'uint64',
871            'disk': ['GuestDiskAddress']} }
874 # @guest-get-fsinfo:
876 # Returns: The list of filesystems information mounted in the guest.
877 #          The returned mountpoints may be specified to
878 #          @guest-fsfreeze-freeze-list.
879 #          Network filesystems (such as CIFS and NFS) are not listed.
881 # Since: 2.2
883 { 'command': 'guest-get-fsinfo',
884   'returns': ['GuestFilesystemInfo'] }
887 # @guest-set-user-password:
889 # @username: the user account whose password to change
890 # @password: the new password entry string, base64 encoded
891 # @crypted: true if password is already crypt()d, false if raw
893 # If the @crypted flag is true, it is the caller's responsibility
894 # to ensure the correct crypt() encryption scheme is used. This
895 # command does not attempt to interpret or report on the encryption
896 # scheme. Refer to the documentation of the guest operating system
897 # in question to determine what is supported.
899 # Not all guest operating systems will support use of the
900 # @crypted flag, as they may require the clear-text password
902 # The @password parameter must always be base64 encoded before
903 # transmission, even if already crypt()d, to ensure it is 8-bit
904 # safe when passed as JSON.
906 # Returns: Nothing on success.
908 # Since: 2.3
910 { 'command': 'guest-set-user-password',
911   'data': { 'username': 'str', 'password': 'str', 'crypted': 'bool' } }
914 # @GuestMemoryBlock:
916 # @phys-index: Arbitrary guest-specific unique identifier of the MEMORY BLOCK.
918 # @online: Whether the MEMORY BLOCK is enabled in guest.
920 # @can-offline: Whether offlining the MEMORY BLOCK is possible.
921 #               This member is always filled in by the guest agent when the
922 #               structure is returned, and always ignored on input (hence it
923 #               can be omitted then).
925 # Since: 2.3
927 { 'struct': 'GuestMemoryBlock',
928   'data': {'phys-index': 'uint64',
929            'online': 'bool',
930            '*can-offline': 'bool'} }
933 # @guest-get-memory-blocks:
935 # Retrieve the list of the guest's memory blocks.
937 # This is a read-only operation.
939 # Returns: The list of all memory blocks the guest knows about.
940 # Each memory block is put on the list exactly once, but their order
941 # is unspecified.
943 # Since: 2.3
945 { 'command': 'guest-get-memory-blocks',
946   'returns': ['GuestMemoryBlock'] }
949 # @GuestMemoryBlockResponseType:
951 # An enumeration of memory block operation result.
953 # @success: the operation of online/offline memory block is successful.
954 # @not-found: can't find the corresponding memoryXXX directory in sysfs.
955 # @operation-not-supported: for some old kernels, it does not support
956 #                           online or offline memory block.
957 # @operation-failed: the operation of online/offline memory block fails,
958 #                    because of some errors happen.
960 # Since: 2.3
962 { 'enum': 'GuestMemoryBlockResponseType',
963   'data': ['success', 'not-found', 'operation-not-supported',
964            'operation-failed'] }
967 # @GuestMemoryBlockResponse:
969 # @phys-index: same with the 'phys-index' member of @GuestMemoryBlock.
971 # @response: the result of memory block operation.
973 # @error-code: the error number.
974 #               When memory block operation fails, we assign the value of
975 #               'errno' to this member, it indicates what goes wrong.
976 #               When the operation succeeds, it will be omitted.
978 # Since: 2.3
980 { 'struct': 'GuestMemoryBlockResponse',
981   'data': { 'phys-index': 'uint64',
982             'response': 'GuestMemoryBlockResponseType',
983             '*error-code': 'int' }}
986 # @guest-set-memory-blocks:
988 # Attempt to reconfigure (currently: enable/disable) state of memory blocks
989 # inside the guest.
991 # The input list is processed node by node in order. In each node @phys-index
992 # is used to look up the guest MEMORY BLOCK, for which @online specifies the
993 # requested state. The set of distinct @phys-index's is only required to be a
994 # subset of the guest-supported identifiers. There's no restriction on list
995 # length or on repeating the same @phys-index (with possibly different @online
996 # field).
997 # Preferably the input list should describe a modified subset of
998 # @guest-get-memory-blocks' return value.
1000 # Returns: The operation results, it is a list of @GuestMemoryBlockResponse,
1001 #          which is corresponding to the input list.
1003 #          Note: it will return NULL if the @mem-blks list was empty on input,
1004 #          or there is an error, and in this case, guest state will not be
1005 #          changed.
1007 # Since: 2.3
1009 { 'command': 'guest-set-memory-blocks',
1010   'data':    {'mem-blks': ['GuestMemoryBlock'] },
1011   'returns': ['GuestMemoryBlockResponse'] }
1014 # @GuestMemoryBlockInfo:
1016 # @size: the size (in bytes) of the guest memory blocks,
1017 #        which are the minimal units of memory block online/offline
1018 #        operations (also called Logical Memory Hotplug).
1020 # Since: 2.3
1022 { 'struct': 'GuestMemoryBlockInfo',
1023   'data': {'size': 'uint64'} }
1026 # @guest-get-memory-block-info:
1028 # Get information relating to guest memory blocks.
1030 # Returns: @GuestMemoryBlockInfo
1032 # Since: 2.3
1034 { 'command': 'guest-get-memory-block-info',
1035   'returns': 'GuestMemoryBlockInfo' }
1038 # @GuestExecStatus:
1040 # @exited: true if process has already terminated.
1041 # @exitcode: process exit code if it was normally terminated.
1042 # @signal: signal number (linux) or unhandled exception code
1043 #       (windows) if the process was abnormally terminated.
1044 # @out-data: base64-encoded stdout of the process
1045 # @err-data: base64-encoded stderr of the process
1046 #       Note: @out-data and @err-data are present only
1047 #       if 'capture-output' was specified for 'guest-exec'
1048 # @out-truncated: true if stdout was not fully captured
1049 #       due to size limitation.
1050 # @err-truncated: true if stderr was not fully captured
1051 #       due to size limitation.
1053 # Since: 2.5
1055 { 'struct': 'GuestExecStatus',
1056   'data': { 'exited': 'bool', '*exitcode': 'int', '*signal': 'int',
1057             '*out-data': 'str', '*err-data': 'str',
1058             '*out-truncated': 'bool', '*err-truncated': 'bool' }}
1060 # @guest-exec-status:
1062 # Check status of process associated with PID retrieved via guest-exec.
1063 # Reap the process and associated metadata if it has exited.
1065 # @pid: pid returned from guest-exec
1067 # Returns: GuestExecStatus on success.
1069 # Since: 2.5
1071 { 'command': 'guest-exec-status',
1072   'data':    { 'pid': 'int' },
1073   'returns': 'GuestExecStatus' }
1076 # @GuestExec:
1077 # @pid: pid of child process in guest OS
1079 # Since: 2.5
1081 { 'struct': 'GuestExec',
1082   'data': { 'pid': 'int'} }
1085 # @guest-exec:
1087 # Execute a command in the guest
1089 # @path: path or executable name to execute
1090 # @arg: argument list to pass to executable
1091 # @env: environment variables to pass to executable
1092 # @input-data: data to be passed to process stdin (base64 encoded)
1093 # @capture-output: bool flag to enable capture of
1094 #                  stdout/stderr of running process. defaults to false.
1096 # Returns: PID on success.
1098 # Since: 2.5
1100 { 'command': 'guest-exec',
1101   'data':    { 'path': 'str', '*arg': ['str'], '*env': ['str'],
1102                '*input-data': 'str', '*capture-output': 'bool' },
1103   'returns': 'GuestExec' }
1107 # @GuestHostName:
1108 # @host-name: Fully qualified domain name of the guest OS
1110 # Since: 2.10
1112 { 'struct': 'GuestHostName',
1113   'data':   { 'host-name': 'str' } }
1116 # @guest-get-host-name:
1118 # Return a name for the machine.
1120 # The returned name is not necessarily a fully-qualified domain name, or even
1121 # present in DNS or some other name service at all. It need not even be unique
1122 # on your local network or site, but usually it is.
1124 # Returns: the host name of the machine on success
1126 # Since: 2.10
1128 { 'command': 'guest-get-host-name',
1129   'returns': 'GuestHostName' }
1133 # @GuestUser:
1134 # @user:       Username
1135 # @domain:     Logon domain (windows only)
1136 # @login-time: Time of login of this user on the computer. If multiple
1137 #              instances of the user are logged in, the earliest login time is
1138 #              reported. The value is in fractional seconds since epoch time.
1140 # Since: 2.10
1142 { 'struct': 'GuestUser',
1143   'data': { 'user': 'str', 'login-time': 'number', '*domain': 'str' } }
1146 # @guest-get-users:
1147 # Retrieves a list of currently active users on the VM.
1149 # Returns: A unique list of users.
1151 # Since: 2.10
1153 { 'command': 'guest-get-users',
1154   'returns': ['GuestUser'] }
1157 # @GuestTimezone:
1159 # @zone:    Timezone name. These values may differ depending on guest/OS and
1160 #           should only be used for informational purposes.
1161 # @offset:  Offset to UTC in seconds, negative numbers for time zones west of
1162 #           GMT, positive numbers for east
1164 # Since: 2.10
1166 { 'struct': 'GuestTimezone',
1167   'data':   { '*zone': 'str', 'offset': 'int' } }
1170 # @guest-get-timezone:
1172 # Retrieves the timezone information from the guest.
1174 # Returns: A GuestTimezone dictionary.
1176 # Since: 2.10
1178 { 'command': 'guest-get-timezone',
1179   'returns': 'GuestTimezone' }
1182 # @GuestOSInfo:
1184 # @kernel-release:
1185 #     * POSIX: release field returned by uname(2)
1186 #     * Windows: build number of the OS
1187 # @kernel-version:
1188 #     * POSIX: version field returned by uname(2)
1189 #     * Windows: version number of the OS
1190 # @machine:
1191 #     * POSIX: machine field returned by uname(2)
1192 #     * Windows: one of x86, x86_64, arm, ia64
1193 # @id:
1194 #     * POSIX: as defined by os-release(5)
1195 #     * Windows: contains string "mswindows"
1196 # @name:
1197 #     * POSIX: as defined by os-release(5)
1198 #     * Windows: contains string "Microsoft Windows"
1199 # @pretty-name:
1200 #     * POSIX: as defined by os-release(5)
1201 #     * Windows: product name, e.g. "Microsoft Windows 10 Enterprise"
1202 # @version:
1203 #     * POSIX: as defined by os-release(5)
1204 #     * Windows: long version string, e.g. "Microsoft Windows Server 2008"
1205 # @version-id:
1206 #     * POSIX: as defined by os-release(5)
1207 #     * Windows: short version identifier, e.g. "7" or "20012r2"
1208 # @variant:
1209 #     * POSIX: as defined by os-release(5)
1210 #     * Windows: contains string "server" or "client"
1211 # @variant-id:
1212 #     * POSIX: as defined by os-release(5)
1213 #     * Windows: contains string "server" or "client"
1215 # Notes:
1217 # On POSIX systems the fields @id, @name, @pretty-name, @version, @version-id,
1218 # @variant and @variant-id follow the definition specified in os-release(5).
1219 # Refer to the manual page for exact description of the fields. Their values
1220 # are taken from the os-release file. If the file is not present in the system,
1221 # or the values are not present in the file, the fields are not included.
1223 # On Windows the values are filled from information gathered from the system.
1225 # Since: 2.10
1227 { 'struct': 'GuestOSInfo',
1228   'data': {
1229       '*kernel-release': 'str', '*kernel-version': 'str',
1230       '*machine': 'str', '*id': 'str', '*name': 'str',
1231       '*pretty-name': 'str', '*version': 'str', '*version-id': 'str',
1232       '*variant': 'str', '*variant-id': 'str' } }
1235 # @guest-get-osinfo:
1237 # Retrieve guest operating system information
1239 # Returns: @GuestOSInfo
1241 # Since: 2.10
1243 { 'command': 'guest-get-osinfo',
1244   'returns': 'GuestOSInfo' }