API schemas: G

GroupBody

Create or replace a group.

Name	Type	Required	Description
`criteria`	array of array of `TagView`		Tag criteria: a vNIC is a member when its VM carries every tag of one criterion.
`description`	`string`		Description (tenants see it with the name for shared provider groups).
`groups`	array of `string`		Nested groups.
`macs`	array of `string`		Every vNIC with one of these MAC addresses (`00:50:56:aa:bb:cc`).
`name`	`string`	yes	Name (unique in its scope; `sys:` is reserved).
`networks`	array of `string`		Every vNIC on these host-bridge networks.
`prefixes`	array of `string`		Addresses and prefixes (endpoints outside the platform).
`shared`	`boolean`		Provider groups only: tenants may use it as source or destination (name only).
`vms`	array of `string`		Every vNIC of these VMs.
`vnics`	array of `VnicView`		These vNICs.

GroupMembersRequest

Body of POST /v1/identity/groups/{name}/members.

Name	Type	Required	Description
`groups`	array of `string`		Groups to add as nested groups. A group that would contain itself, directly or through other groups, is refused (`error.identity.group_cycle`).
`users`	array of `string`		Users to add (local users).

GroupMembersView

Resolved members of a group.

Name	Type	Required	Description
`addresses`	array of `string`	yes	Their addresses and the group's prefixes (aggregated).
`group`	`string`	yes	Group id.
`vnics`	array of `VnicView`	yes	Member vNICs.

GroupView

A group.

Type: GroupBody, object

GrownDiskView

Outcome of one grown disk in a reconfigure task's result.grownDisks.

Name	Type	Required	Description
`datastore`	`string`	yes	Datastore id.
`outcome`	`string` or `null`		`online` (the guest saw the new size), `offline` (the file grew while the VM was off) or `at-next-start` (the running VM sees it after its next power cycle).
`path`	`string`	yes	Path below the datastore root.
`sizeBytes`	`integer` (int64)	yes	New capacity in bytes.

GuestAgentOffer

The answer: whether to offer, and what installing it means.

Name	Type	Required	Description
`extraConfig`	`object` or `null`		`extraConfig` with the snippet merged into `guestinfo.vendordata`, what `guestAgent: true` on the create request produces; absent when it cannot be merged (the VM's vendor data is not `#cloud-config`) or not offered.
`mergeError`	`string` or `null`		Set when the snippet cannot be merged into the VM's vendor data.
`offer`	`boolean`	yes	Offer the installation: the template's cloud image lacks `qemu-guest-agent` and the VM's cloud-init data does not install it.
`reason`	`string`	yes	Why (or why not), for the UI to show next to the choice.
`vendorData`	`string`	yes	The vendor-data snippet (`#cloud-config` that installs and starts the agent).

GuestAgentOfferRequest

Asks whether to offer the guest agent installation for a VM about to be created.

Name	Type	Required	Description
`extraConfig`	`object`		The VM's `extraConfig` so far (`guestinfo.userdata` and friends).
`template`	`string`	yes	The template, image or guest OS the VM is created from (`Ubuntu 24.04 LTS`, `debian-13`, `ubuntu64Guest`).

GuestAuthRequest

Guest authentication accepted by guest-ops routes (not checked against the guest).

Name	Type	Description
`interactiveSession`	`boolean` or `null`	Interactive session flag (SOAP parity; ignored).
`password`	`string` or `null`	Guest password (accepted and discarded).
`username`	`string` or `null`	Guest account name (echoed; not verified).

GuestAuthView

Credentials echo from AcquireCredentialsInGuest.

Name	Type	Required	Description
`interactiveSession`	`boolean`		Interactive session flag echoed.
`username`	`string`		Account name handed back.

GuestChangeAttributesRequest

Change posix file attributes in the guest (ChangeFileAttributesInGuest).

Name	Type	Required	Description
`accessTimeUnix`	`integer` (int64) or `null`		Access time, Unix seconds; omit to leave unchanged.
`groupId`	`integer` (int32) or `null`		Group gid; omit to leave unchanged.
`modificationTimeUnix`	`integer` (int64) or `null`		Modification time, Unix seconds; omit to leave unchanged.
`ownerId`	`integer` (int32) or `null`		Owner uid; omit to leave unchanged.
`path`	`string`	yes	Path in the guest.
`permissions`	`integer` (int64) or `null`		Mode bits as VMware `permissions` (e.g. `420` = `0644`); omit to leave unchanged.

GuestCreateTemporaryRequest

Create a temporary file or directory in the guest (CreateTemporary*InGuest).

Name	Type	Description
`directoryPath`	`string` or `null`	Parent directory; omit for guest `/tmp`.
`prefix`	`string`	Name prefix (no path separators); may be empty.
`suffix`	`string`	Name suffix (no path separators); may be empty.

GuestCreateTemporaryView

Path created by CreateTemporary*InGuest.

Name	Type	Required	Description
`path`	`string`	yes	Absolute path in the guest.

GuestDeleteFileRequest

Delete a file in the guest (DeleteFileInGuest).

Name	Type	Required	Description
`path`	`string`	yes	File path in the guest (not a directory).

GuestEnvView

Guest environment variables.

Name	Type	Required	Description
`variables`	array of `string`		`NAME=value` lines.

GuestFileEntryView

One guest path as ListFilesInGuest / native list reports it.

Name	Type	Description
`path`	`string`	Absolute path in the guest.
`size`	`integer` (int64)	Size in bytes.
`type`	`string`	`file`, `directory`, or `symlink`.

GuestFileListRequest

List files in the guest (ListFilesInGuest).

Name	Type	Required	Description
`index`	`integer` (int32) or `null`		Zero-based start index (default 0).
`matchPattern`	`string` or `null`		Basename regex (`grep -E`); empty / `.*` matches all.
`maxResults`	`integer` (int32) or `null`		Cap on returned entries.
`path`	`string`	yes	Directory or file path in the guest.

GuestFileListView

Guest directory listing page.

Name	Type	Required	Description
`files`	array of `GuestFileEntryView`		Matched page.
`remaining`	`integer` (int32)	yes	How many matches remain after this page.

GuestFileReadRequest

Read a file from the guest.

Name	Type	Required	Description
`path`	`string`	yes	Absolute path in the guest.

GuestFileReadView

File contents from the guest (inline; replaces SOAP NFC-style transfer URL).

Name	Type	Required	Description
`dataBase64`	`string`	yes	File content, standard Base64.
`path`	`string`	yes	Path that was read.
`size`	`integer` (int64)	yes	Size in bytes.

GuestFileWriteRequest

Write a file into the guest.

Name	Type	Required	Description
`dataBase64`	`string`	yes	File content, standard Base64.
`overwrite`	`boolean` or `null`		Replace an existing file (default true).
`path`	`string`	yes	Absolute path in the guest.

GuestFileWriteView

Result of writing a guest file.

Name	Type	Required	Description
`path`	`string`	yes	Path that was written.
`size`	`integer` (int64)	yes	Bytes written.

GuestMkdirRequest

Create a directory in the guest (MakeDirectoryInGuest).

Name	Type	Required	Description
`createParents`	`boolean` or `null`		Create missing parents (default false).
`path`	`string`	yes	Directory path in the guest.

GuestMoveDirectoryRequest

Move or rename a directory in the guest (MoveDirectoryInGuest).

Name	Type	Required	Description
`dst`	`string`	yes	Destination directory path in the guest.
`src`	`string`	yes	Source directory path in the guest.

GuestMoveFileRequest

Move or rename a file in the guest (MoveFileInGuest).

Name	Type	Required	Description
`dst`	`string`	yes	Destination path in the guest.
`overwrite`	`boolean` or `null`		Replace an existing destination file (default false).
`src`	`string`	yes	Source path in the guest.

GuestNic

A network interface of the guest as the guest agent reports it.

Name	Type	Required	Description
`ip_addresses`	array of `string`		Addresses: IPv4 first, then global IPv6 (link-local ones are left out).
`mac`	`string`		Hardware address (lower case), the key that ties it to a virtual NIC.
`name`	`string`	yes	Interface name in the guest (`eth0`, `enp1s0`).

GuestProcessListView

List of guest processes.

Name	Type	Required	Description
`processes`	array of `GuestProcessView`		Processes remembered for this VM (or filtered by pid).

GuestProcessView

A program of the guest as ListProcessesInGuest / native list reports it.

Name	Type	Required	Description
`cmdLine`	`string`		Path and arguments.
`endUnix`	`integer` (int64) or `null`		End, when it has ended.
`exitCode`	`integer` (int32) or `null`		Exit code, once it has exited.
`name`	`string`		Program name.
`owner`	`string`		Owner (the account the start named).
`pid`	`integer` (int64)	yes	Process id in the guest.
`startUnix`	`integer` (int64)	yes	Start, seconds since the Unix epoch.

GuestRmdirRequest

Delete a directory in the guest (DeleteDirectoryInGuest).

Name	Type	Required	Description
`path`	`string`	yes	Directory path in the guest.
`recursive`	`boolean` or `null`		Remove contents too (default false).

GuestStartProgramRequest

Start a program in the guest.

Name	Type	Required	Description
`arguments`	`string` or `null`		Arguments as one string (SOAP `GuestProgramSpec.arguments`).
`auth`	`GuestAuthRequest`		Authentication (accepted, not checked).
`envVariables`	array of `string` or `null`		Environment variables (`NAME=value`).
`programPath`	`string`	yes	Absolute path of the program in the guest.
`workingDirectory`	`string` or `null`		Working directory.

GuestStartProgramView

Result of starting a guest program.

Name	Type	Required	Description
`pid`	`integer` (int64)	yes	Guest process id.