2011-07-19 22:41:55 +02:00
|
|
|
# *-*- Mode: Python -*-*
|
|
|
|
|
|
|
|
##
|
|
|
|
# @guest-sync:
|
|
|
|
#
|
|
|
|
# Echo back a unique integer value
|
|
|
|
#
|
|
|
|
# This is used by clients talking to the guest agent over the
|
|
|
|
# wire to ensure the stream is in sync and doesn't contain stale
|
|
|
|
# data from previous client. All guest agent responses should be
|
|
|
|
# ignored until the provided unique integer value is returned,
|
|
|
|
# and it is up to the client to handle stale whole or
|
|
|
|
# partially-delivered JSON text in such a way that this response
|
|
|
|
# can be obtained.
|
|
|
|
#
|
2011-12-10 00:19:46 +01:00
|
|
|
# Such clients should also precede this command
|
2011-07-19 22:41:55 +02:00
|
|
|
# with a 0xFF byte to make such the guest agent flushes any
|
|
|
|
# partially read JSON data from a previous session.
|
|
|
|
#
|
|
|
|
# @id: randomly generated 64-bit integer
|
|
|
|
#
|
|
|
|
# Returns: The unique integer id passed in by the client
|
|
|
|
#
|
|
|
|
# Since: 0.15.0
|
|
|
|
##
|
|
|
|
{ 'command': 'guest-sync'
|
|
|
|
'data': { 'id': 'int' },
|
|
|
|
'returns': 'int' }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @guest-ping:
|
|
|
|
#
|
|
|
|
# Ping the guest agent, a non-error return implies success
|
|
|
|
#
|
|
|
|
# Since: 0.15.0
|
|
|
|
##
|
|
|
|
{ 'command': 'guest-ping' }
|
|
|
|
|
|
|
|
##
|
2012-01-17 00:44:16 +01:00
|
|
|
# @GuestAgentCommandInfo:
|
2011-07-19 22:41:55 +02:00
|
|
|
#
|
2012-01-17 00:44:16 +01:00
|
|
|
# Information about guest agent commands.
|
2011-07-19 22:41:55 +02:00
|
|
|
#
|
2012-01-17 00:44:16 +01:00
|
|
|
# @name: name of the command
|
|
|
|
#
|
|
|
|
# @enabled: whether command is currently enabled by guest admin
|
|
|
|
#
|
|
|
|
# Since 1.1.0
|
2011-07-19 22:41:55 +02:00
|
|
|
##
|
2011-12-07 05:03:43 +01:00
|
|
|
{ 'type': 'GuestAgentCommandInfo',
|
|
|
|
'data': { 'name': 'str', 'enabled': 'bool' } }
|
2012-01-17 00:44:16 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @GuestAgentInfo
|
|
|
|
#
|
|
|
|
# Information about guest agent.
|
|
|
|
#
|
|
|
|
# @version: guest agent version
|
|
|
|
#
|
|
|
|
# @supported_commands: Information about guest agent commands
|
|
|
|
#
|
|
|
|
# Since 0.15.0
|
|
|
|
##
|
2011-12-07 05:03:43 +01:00
|
|
|
{ 'type': 'GuestAgentInfo',
|
|
|
|
'data': { 'version': 'str',
|
|
|
|
'supported_commands': ['GuestAgentCommandInfo'] } }
|
2012-01-17 00:44:16 +01:00
|
|
|
##
|
|
|
|
# @guest-info:
|
|
|
|
#
|
|
|
|
# Get some information about the guest agent.
|
|
|
|
#
|
|
|
|
# Returns: @GuestAgentInfo
|
|
|
|
#
|
|
|
|
# Since: 0.15.0
|
|
|
|
##
|
2011-07-19 22:41:55 +02:00
|
|
|
{ 'command': 'guest-info',
|
|
|
|
'returns': 'GuestAgentInfo' }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @guest-shutdown:
|
|
|
|
#
|
|
|
|
# Initiate guest-activated shutdown. Note: this is an asynchronous
|
|
|
|
# shutdown request, with no guaruntee of successful shutdown. Errors
|
|
|
|
# will be logged to guest's syslog.
|
|
|
|
#
|
|
|
|
# @mode: #optional "halt", "powerdown" (default), or "reboot"
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success
|
|
|
|
#
|
|
|
|
# Since: 0.15.0
|
|
|
|
##
|
|
|
|
{ 'command': 'guest-shutdown', 'data': { '*mode': 'str' } }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @guest-file-open:
|
|
|
|
#
|
|
|
|
# Open a file in the guest and retrieve a file handle for it
|
|
|
|
#
|
|
|
|
# @filepath: Full path to the file in the guest to open.
|
|
|
|
#
|
|
|
|
# @mode: #optional open mode, as per fopen(), "r" is the default.
|
|
|
|
#
|
|
|
|
# Returns: Guest file handle on success.
|
|
|
|
#
|
|
|
|
# Since: 0.15.0
|
|
|
|
##
|
|
|
|
{ 'command': 'guest-file-open',
|
|
|
|
'data': { 'path': 'str', '*mode': 'str' },
|
|
|
|
'returns': 'int' }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @guest-file-close:
|
|
|
|
#
|
|
|
|
# Close an open file in the guest
|
|
|
|
#
|
|
|
|
# @handle: filehandle returned by guest-file-open
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success.
|
|
|
|
#
|
|
|
|
# Since: 0.15.0
|
|
|
|
##
|
|
|
|
{ 'command': 'guest-file-close',
|
|
|
|
'data': { 'handle': 'int' } }
|
|
|
|
|
2012-01-17 00:44:16 +01:00
|
|
|
##
|
|
|
|
# @GuestFileRead
|
|
|
|
#
|
|
|
|
# Result of guest agent file-read operation
|
|
|
|
#
|
|
|
|
# @count: number of bytes read (note: count is *before*
|
|
|
|
# base64-encoding is applied)
|
|
|
|
#
|
|
|
|
# @buf-b64: base64-encoded bytes read
|
|
|
|
#
|
|
|
|
# @eof: whether EOF was encountered during read operation.
|
|
|
|
#
|
|
|
|
# Since: 0.15.0
|
|
|
|
##
|
|
|
|
{ 'type': 'GuestFileRead',
|
|
|
|
'data': { 'count': 'int', 'buf-b64': 'str', 'eof': 'bool' } }
|
|
|
|
|
2011-07-19 22:41:55 +02:00
|
|
|
##
|
|
|
|
# @guest-file-read:
|
|
|
|
#
|
|
|
|
# Read from an open file in the guest. Data will be base64-encoded
|
|
|
|
#
|
|
|
|
# @handle: filehandle returned by guest-file-open
|
|
|
|
#
|
|
|
|
# @count: #optional maximum number of bytes to read (default is 4KB)
|
|
|
|
#
|
2012-01-17 00:44:16 +01:00
|
|
|
# Returns: @GuestFileRead on success.
|
2011-07-19 22:41:55 +02:00
|
|
|
#
|
|
|
|
# Since: 0.15.0
|
|
|
|
##
|
|
|
|
{ 'command': 'guest-file-read',
|
|
|
|
'data': { 'handle': 'int', '*count': 'int' },
|
|
|
|
'returns': 'GuestFileRead' }
|
|
|
|
|
2012-01-17 00:44:16 +01:00
|
|
|
##
|
|
|
|
# @GuestFileWrite
|
|
|
|
#
|
|
|
|
# Result of guest agent file-write operation
|
|
|
|
#
|
|
|
|
# @count: number of bytes written (note: count is actual bytes
|
|
|
|
# written, after base64-decoding of provided buffer)
|
|
|
|
#
|
|
|
|
# @eof: whether EOF was encountered during write operation.
|
|
|
|
#
|
|
|
|
# Since: 0.15.0
|
|
|
|
##
|
|
|
|
{ 'type': 'GuestFileWrite',
|
|
|
|
'data': { 'count': 'int', 'eof': 'bool' } }
|
|
|
|
|
2011-07-19 22:41:55 +02:00
|
|
|
##
|
|
|
|
# @guest-file-write:
|
|
|
|
#
|
|
|
|
# Write to an open file in the guest.
|
|
|
|
#
|
|
|
|
# @handle: filehandle returned by guest-file-open
|
|
|
|
#
|
|
|
|
# @buf-b64: base64-encoded string representing data to be written
|
|
|
|
#
|
|
|
|
# @count: #optional bytes to write (actual bytes, after base64-decode),
|
|
|
|
# default is all content in buf-b64 buffer after base64 decoding
|
|
|
|
#
|
2012-01-17 00:44:16 +01:00
|
|
|
# Returns: @GuestFileWrite on success.
|
2011-07-19 22:41:55 +02:00
|
|
|
#
|
|
|
|
# Since: 0.15.0
|
|
|
|
##
|
|
|
|
{ 'command': 'guest-file-write',
|
|
|
|
'data': { 'handle': 'int', 'buf-b64': 'str', '*count': 'int' },
|
|
|
|
'returns': 'GuestFileWrite' }
|
|
|
|
|
2012-01-17 00:44:16 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @GuestFileSeek
|
|
|
|
#
|
|
|
|
# Result of guest agent file-seek operation
|
|
|
|
#
|
|
|
|
# @position: current file position
|
|
|
|
#
|
|
|
|
# @eof: whether EOF was encountered during file seek
|
|
|
|
#
|
|
|
|
# Since: 0.15.0
|
|
|
|
##
|
|
|
|
{ 'type': 'GuestFileSeek',
|
|
|
|
'data': { 'position': 'int', 'eof': 'bool' } }
|
|
|
|
|
2011-07-19 22:41:55 +02:00
|
|
|
##
|
|
|
|
# @guest-file-seek:
|
|
|
|
#
|
|
|
|
# Seek to a position in the file, as with fseek(), and return the
|
|
|
|
# current file position afterward. Also encapsulates ftell()'s
|
|
|
|
# functionality, just Set offset=0, whence=SEEK_CUR.
|
|
|
|
#
|
|
|
|
# @handle: filehandle returned by guest-file-open
|
|
|
|
#
|
|
|
|
# @offset: bytes to skip over in the file stream
|
|
|
|
#
|
|
|
|
# @whence: SEEK_SET, SEEK_CUR, or SEEK_END, as with fseek()
|
|
|
|
#
|
2012-01-17 00:44:16 +01:00
|
|
|
# Returns: @GuestFileSeek on success.
|
2011-07-19 22:41:55 +02:00
|
|
|
#
|
|
|
|
# Since: 0.15.0
|
|
|
|
##
|
|
|
|
{ 'command': 'guest-file-seek',
|
|
|
|
'data': { 'handle': 'int', 'offset': 'int', 'whence': 'int' },
|
|
|
|
'returns': 'GuestFileSeek' }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @guest-file-flush:
|
|
|
|
#
|
|
|
|
# Write file changes bufferred in userspace to disk/kernel buffers
|
|
|
|
#
|
|
|
|
# @handle: filehandle returned by guest-file-open
|
|
|
|
#
|
|
|
|
# Returns: Nothing on success.
|
|
|
|
#
|
|
|
|
# Since: 0.15.0
|
|
|
|
##
|
|
|
|
{ 'command': 'guest-file-flush',
|
|
|
|
'data': { 'handle': 'int' } }
|
|
|
|
|
|
|
|
##
|
2012-01-17 00:44:16 +01:00
|
|
|
# @GuestFsFreezeStatus
|
2011-07-19 22:41:55 +02:00
|
|
|
#
|
2012-01-17 00:44:16 +01:00
|
|
|
# An enumation of filesystem freeze states
|
2011-07-19 22:41:55 +02:00
|
|
|
#
|
2012-01-17 00:44:16 +01:00
|
|
|
# @thawed: filesystems thawed/unfrozen
|
|
|
|
#
|
|
|
|
# @frozen: all non-network guest filesystems frozen
|
|
|
|
#
|
|
|
|
# @error: failure to thaw 1 or more
|
|
|
|
# previously frozen filesystems, or failure to open a previously
|
|
|
|
# cached filesytem (filesystem unmounted/directory changes, etc).
|
2011-07-19 22:41:55 +02:00
|
|
|
#
|
|
|
|
# Since: 0.15.0
|
|
|
|
##
|
|
|
|
{ 'enum': 'GuestFsfreezeStatus',
|
|
|
|
'data': [ 'thawed', 'frozen', 'error' ] }
|
2012-01-17 00:44:16 +01:00
|
|
|
|
|
|
|
##
|
|
|
|
# @guest-fsfreeze-status:
|
|
|
|
#
|
|
|
|
# Get guest fsfreeze state. error state indicates
|
|
|
|
#
|
|
|
|
# Returns: GuestFsfreezeStatus ("thawed", "frozen", etc., as defined below)
|
|
|
|
#
|
|
|
|
# Since: 0.15.0
|
|
|
|
##
|
2011-07-19 22:41:55 +02:00
|
|
|
{ 'command': 'guest-fsfreeze-status',
|
|
|
|
'returns': 'GuestFsfreezeStatus' }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @guest-fsfreeze-freeze:
|
|
|
|
#
|
|
|
|
# Sync and freeze all non-network guest filesystems
|
|
|
|
#
|
|
|
|
# Returns: Number of file systems frozen on success
|
|
|
|
#
|
|
|
|
# Since: 0.15.0
|
|
|
|
##
|
|
|
|
{ 'command': 'guest-fsfreeze-freeze',
|
|
|
|
'returns': 'int' }
|
|
|
|
|
|
|
|
##
|
|
|
|
# @guest-fsfreeze-thaw:
|
|
|
|
#
|
|
|
|
# Unfreeze frozen guest fileystems
|
|
|
|
#
|
|
|
|
# Returns: Number of file systems thawed
|
|
|
|
# If error, -1 (unknown error) or -errno
|
|
|
|
#
|
|
|
|
# Since: 0.15.0
|
|
|
|
##
|
|
|
|
{ 'command': 'guest-fsfreeze-thaw',
|
|
|
|
'returns': 'int' }
|