directory
2.5.3+incompatible
Repository: https://github.com/vtolstov/cloudagent.git
Documentation: pkg.go.dev
# Packages
Package guest_agent_shutdown - shutdown cloudagent inside vm
Example:
{ "execute": "guest-agent-shutdown", "arguments": {
"timeout": int // optional, wait time for shutdown
}
}
*/.
Package guest_agent_update - update cloudagent inside vm
Example:
{ "execute": "guest-agent-update", "arguments": {
"path": string // required, http/https/file path to cloudagent binary for update
"timeout": int // optional, timeout for http/https transport
}
}
*/.
Package guest_exec - run command inside vm
Old command version syntax:
{ "execute": "guest-exec", "arguments": {
"command": string // required, base64 encoded command name to execute with args including newline
}
}
New command version syntax (preferred):
{ "execute": "guest-exec", "arguments": {
"path": string, // required, command name to execute
"arg": string, // optional, arguments to executed command
"env": string, // optional, environment to executed command
"input": string, // optional, base64 encoded string
"capture-output": bool // optional, capture stdout/stderr
}
}
*/.
Package guest_exec_status - get status from running command
Example:
{ "execute": "guest-exec-status", "arguments": {
"pid": int // required, process id from guest-exec
}
}
*/.
Package guest_file_chmod - set file mode
Example:
{ "execute": "guest-file-chmod", "arguments": {
"mode": int // required, file mode
"path": string // optional, file path
"handle": int // optional, file handle
}
}
*/.
Package guest_file_chown - set file owner
Example:
{ "execute": "guest-file-chown", "arguments": {
"uid": int // required, file owner uid
"gid": int // required, file owner gid
"path": string // optional, file path
"handle": int // optional, file handle
}
}
*/.
Package guest_file_close - close file handle
Example:
{ "execute": "guest-file-close", "arguments": {
"handle": int // required, unique fd identifier
}
}
*/.
Package guest_file_flush - flush buffered data to file
Example:
{ "execute": "guest-file-flush", "arguments": {
"handle": int // required, unique fd identifier
}
}
*/.
Package guest_file_open - open file inside guest and returns it handle
Example:
{ "execute": "guest-file-open", "arguments": {
"path": string // required, file path
"mode": string // optional, file open mode
}
}
*/.
Package guest_file_read - read file inside guest via fd
Example:
{ "execute": "guest-file-read", "arguments": {
"handle": int // required, unique fd identifier
"count": int // optional, bytes count to read
}
}
*/.
Package guest_file_seek - seek on file
Example:
{ "execute": "guest-file-seek", "arguments": {
"handle": int // required, unique fd identifier
"offset": int // required, offset inside file
"whence": int // required, starting point to seek (-1, 0, 1)
}
}
*/.
Package guest_file_stat - get stat on file
Example:
{ "execute": "guest-file-stat", "arguments": {
"path": string // optional, file path
"handle": int // optional, file handle
}
}
*/.
Package guest_file_write - write file to fd inside guest
Example:
{ "execute": "guest-file-write", "arguments": {
"handle": int // required, unique fd identifier
"buf-b64": string // required, base64 encoded data
"count": int // optional, number of bytes to write
}
}
*/.
Package guest_fscheck - run check to test filesystem
Example:
{ "execute": "guest-fscheck", "arguments": {
"path": string // optional, path to store tmp files
}
}
*/.
Package guest_fsfreeze_freeze - run fsfreeze on all mounted file systems
Example:
{ "execute": "guest-fsfreeze-freeze", "arguments": {} }
*/.
Package guest_fsfreeze_freeze - run fsfreeze on all mounted file systems
Example:
{ "execute": "guest-fsfreeze-freeze", "arguments": {} }
*/.
Package guest_fsfreeze_status - get status of file systems
Example:
{ "execute": "guest-fsfreeze-status", "arguments": {} }
*/.
Package guest_fsfreeze_thaw - run unfreeze on all mounted file systems
Example:
{ "execute": "guest-fsfreeze-thaw", "arguments": {} }
*/.
Package guest_fsresize - run resize file system
Example:
{ "execute": "guest-fsresize", "arguments": {
"path": string // optional, mounted filesystem path
}
}
*/.
Package guest_fstrim - run fstrim on path
Example:
{ "execute": "guest-fstrim", "arguments": {
"minimum": int // optional, minimum trimmed range
}
}
*/.
Package guest_get_time - get current guest time in nanoseconds
Example:
{ "execute": "guest-get-time", "arguments": {}}
*/.
Package guest_info - request agent info from guest
Example:
{ "execute": "guest-info", "arguments": {}}
*/.
Package guest_memory_info - get guest memory info
Example:
{ "execute": "guest-memory-info", "arguments": {}}
*/.
Package guest_ping - ping guest
Example:
{ "execute": "guest-ping", "arguments": {}}
*/.
Package guest_set_time - set guest time
Example:
{ "execute": "guest-set-time", "arguments": {
"time": int // optional, time to set
}
}
*/.
Package guest_set_user_password - sync host<->guest communication
Example:
{ "execute": "guest-set-user-password", "arguments": {
"username": string // required, username to change password
"password": string // required, base64 encoded password
"crypted": bool // optional, specify that password already encrypted
}
}
*/.
Package guest_shutdown - shutdown guest via agent
Example:
{ "execute": "guest-shutdown", "arguments": {
"mode": string // optional, shutdown mode (halt, reboot, powerdown), default powerdown
}
}
*/.
Package guest_stats - returns disk and memory stats from guest
Example:
{ "execute": "guest-stats", "arguments": {}}
*/.
Package guest_sync - sync host<->guest communication
Example:
{ "execute": "guest-sync", "arguments": {
"id": int // required, unique identifier
}
}
*/.
Package guest_sync_delimited - sync host<->guest communication
Example:
{ "execute": "guest-sync-delimited", "arguments": {
"id": int // required, unique identifier
}
}
*/.