Python models¶

Generated from eve-iac OpenAPI/semantics. Do not edit manually.

Every public OpenAPI component schema plus generated query types.

Model	Kind
`LooseObject`	object
`ValidateData`	object
`BulkResult`	object
`SuccessEnvelope`	object
`ErrorEnvelope`	object
`LoginRequest`	object
`LogoutRequest`	object
`ProjectPayload`	object
`AuthoringPayload`	object
`ConsolePayload`	object
`ConsoleTarget`	object
`HealthData`	object
`LoginData`	object
`StatusOkData`	object
`SessionData`	object
`CapabilitiesData`	object
`ProjectModeCaps`	object
`LifecycleCaps`	object
`Template`	object
`TemplateDetail`	object
`TemplateImage`	object
`TemplateAttribute`	object
`TemplatesData`	object
`TemplateImagesData`	object
`TemplateAttributesData`	object
`NetworkType`	object
`NetworkTypesData`	object
`Icon`	object
`IconsData`	object
`Iface`	object
`LinkCompletionsData`	object
`InterfacesPreviewData`	object
`ImportData`	object
`DeployData`	object
`PlanSummary`	object
`PlanAction`	object
`PlanData`	object
`ReconcileData`	object
`DestroyData`	object
`ProjectStatusData`	object
`InspectionData`	object
`OpenData`	object
`ConsoleRecord`	object
`ConsolesData`	object
`ConsoleExecData`	object
`ConsoleExecManyData`	object
`ConsoleAttachData`	object
`ListTemplatesQuery`	object
`CompleteLinkInterfacesRequest`	ref
`PreviewInterfacesRequest`	ref
`ValidateProjectRequest`	ref
`ImportProjectRequest`	object
`DeployProjectRequest`	ref
`PlanProjectRequest`	ref
`ReconcileProjectRequest`	ref
`DestroyProjectRequest`	ref
`GetProjectStatusRequest`	ref
`InspectProjectRequest`	ref
`OpenProjectRequest`	ref
`ListProjectConsolesRequest`	ref
`ExecProjectRequest`	object
`ExecConsoleRequest`	ref
`ExecConsoleManyRequest`	ref
`AttachConsoleRequest`	ref

Direction is Literal["to_eve", "from_eve"]. ProjectPayload.direction on the wire is still a free string.

LooseObject¶

Type: Mapping[str, Any]

ValidateData¶

Field	Python type	Required	Semantics
`status`	str	yes

Used by: validateProject

BulkResult¶

Field	Python type	Required
`requested`	int	yes
`started`	int	yes
`already_running`	int	yes
`already_starting`	int	yes
`stopped`	int	yes
`already_stopped`	int	yes
`wiped`	int	yes
`failed`	int	yes
`invalid`	int	yes

Used by: execProject

SuccessEnvelope¶

Field	Python type	Required
`ok`	bool	yes
`data`	Any	no
`error`	str	no
`code`	str	no

ErrorEnvelope¶

Field	Python type	Required
`ok`	bool	yes
`error`	str	no
`code`	str	no
`data`	Any	no

LoginRequest¶

Field	Python type	Required	Semantics
`username`	str	yes
`password`	str	yes

Used by: login

LogoutRequest¶

Type: Mapping[str, Any]

Used by: logout

ProjectPayload¶

decodeProject body. Unknown fields are ignored. dir/out non-empty are rejected. Do not treat omitted optional fields as serialized defaults.

Field	Python type	Required	Semantics
`lab`	str	no
`yaml`	str	no
`files`	dict[str, str]	no
`state`	Any	no
`source`	Any	no
`manifest`	str	no
`prune`	bool	no	omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
`wipe`	bool	no	explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
`action`	str	no
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`id`	int	no
`stopmode`	int	no	0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
`refresh`	bool	no	omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
`replace`	bool	no	omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
`plan_identity`	str	no	omitted: recompute the live plan. present: opaque token from the last plan of the same direction
`direction`	str	no	Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
`dir`	str	no	Rejected when non-empty.
`out`	str	no	Rejected when non-empty.

Used by: validateProject, importProject, deployProject, planProject, reconcileProject, destroyProject, getProjectStatus, inspectProject, openProject, listProjectConsoles, execProject

AuthoringPayload¶

Field	Python type	Required	Semantics
`dir`	str	no	Rejected when non-empty.
`yaml`	str	no
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`template`	str	no
`attributes`	Mapping[str, Any]	no
`excludeUsed`	bool	no
`eth_format`	str	no

Used by: completeLinkInterfaces, previewInterfaces

ConsolePayload¶

Field	Python type	Required	Semantics
`lab`	str	no
`yaml`	str	no
`files`	dict[str, str]	no
`state`	Any	no
`manifest`	str	no
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`command`	str	no
`timeout_ms`	int	no
`targets`	list[`ConsoleTarget`]	no
`dir`	str	no	Rejected when non-empty.
`out`	str	no	Rejected when non-empty.

Used by: execConsole, execConsoleMany, attachConsole

ConsoleTarget¶

Field	Python type	Required	Semantics
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`command`	str	no

HealthData¶

Field	Python type	Required
`status`	str	no
`tls`	bool	no
`version`	str	no

Used by: getHealth

LoginData¶

Field	Python type	Required	Semantics
`token`	str	no
`username`	str	no

Used by: login

StatusOkData¶

Field	Python type	Required	Semantics
`status`	str	no

Used by: logout

SessionData¶

Field	Python type	Required	Semantics
`username`	str	no

Used by: getSession

CapabilitiesData¶

Field	Python type	Required
`eveReachable`	bool	no
`eveBaseUrl`	str	no
`features`	dict[str, bool]	no
`projectModes`	dict[str, `ProjectModeCaps`]	no

Used by: getCapabilities

ProjectModeCaps¶

Field	Python type	Required
`inspect`	bool	no
`open`	bool	no
`console`	bool	no
`lifecycle`	`LifecycleCaps`	no
`topology_mutation`	bool	no
`reconcile`	bool	no
`destroy`	bool	no
`presentation_restore`	bool	no
`source_mutation`	bool	no

LifecycleCaps¶

Field	Python type	Required	Semantics
`start`	bool	no
`stop`	bool	no
`wipe`	bool	no	explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)

Template¶

Field	Python type	Required
`id`	str	no
`description`	str	no
`type`	str	no
`provisioned`	bool	no
`configSupported`	bool	no

TemplateDetail¶

Field	Python type	Required
`id`	str	no
`description`	str	no
`type`	str	no
`provisioned`	bool	no
`configSupported`	bool	no
`images`	list[`TemplateImage`]	no
`default`	str	no
`attributes`	list[`TemplateAttribute`]	no

Used by: getTemplate

TemplateImage¶

Field	Python type	Required	Semantics
`id`	str	no
`available`	bool	no

TemplateAttribute¶

Field	Python type	Required
`name`	str	no
`label`	str	no
`kind`	str	no
`group`	str	no
`values`	list[str]	no

TemplatesData¶

Field	Python type	Required	Semantics
`templates`	list[`Template`]	no

Used by: listTemplates

TemplateImagesData¶

Field	Python type	Required
`template`	str	no
`type`	str	no
`provisioned`	bool	no
`default`	str	no
`images`	list[`TemplateImage`]	no

Used by: listTemplateImages

TemplateAttributesData¶

Field	Python type	Required
`template`	str	no
`type`	str	no
`attributes`	list[`TemplateAttribute`]	no

Used by: listTemplateAttributes

NetworkType¶

Field	Python type	Required
`id`	str	no
`label`	str	no
`icon`	str	no
`supported`	bool	no

NetworkTypesData¶

Field	Python type	Required	Semantics
`types`	list[`NetworkType`]	no
`natOnly`	bool	no

Used by: listNetworkTypes

Icon¶

Field	Python type	Required	Semantics
`id`	str	no
`label`	str	no

IconsData¶

Field	Python type	Required	Semantics
`icons`	list[`Icon`]	no

Used by: listIcons

Iface¶

Field	Python type	Required
`id`	int	no
`name`	str	no
`type`	str	no
`used`	bool	no

LinkCompletionsData¶

Field	Python type	Required	Semantics
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`items`	list[`Iface`]	no

Used by: completeLinkInterfaces

InterfacesPreviewData¶

Field	Python type	Required	Semantics
`items`	list[`Iface`]	no

Used by: previewInterfaces

ImportData¶

Field	Python type	Required
`name`	str	no
`yaml`	str	no
`files`	dict[str, str]	no
`mode`	str	no
`source_lab`	str	no
`managed_lab`	str	no
`lab`	str	no
`state`	Any	no
`source`	Any	no

Used by: importProject

DeployData¶

Field	Python type	Required
`lab`	str	no
`nodes`	int	no
`links`	int	no
`state`	Any	no
`unsupported`	list[str]	no

Used by: deployProject

PlanSummary¶

Field	Python type	Required
`creates`	int	no
`updates`	int	no
`deletes`	int	no
`blocked`	int	no

PlanAction¶

Field	Python type	Required	Semantics
`op`	str	no
`kind`	str	no
`key`	str	no
`side`	str	no
`direction`	str	no	omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
`type`	str	no
`applicable`	bool	no
`prune`	bool	no	omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve

PlanData¶

Field	Python type	Required	Semantics
`lab`	str	no
`exists`	bool	no
`summary`	`PlanSummary`	no
`operations`	list[`PlanAction`]	no
`actions`	list[`PlanAction`]	no
`applicable`	bool	no
`blocked`	list[`PlanAction`]	no
`text`	str	no
`plan_identity`	str	no	omitted: recompute the live plan. present: opaque token from the last plan of the same direction
`locked`	bool	no
`lock`	int	no
`direction`	str	no	omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
`unsupported`	list[str]	no

Used by: planProject

ReconcileData¶

Field	Python type	Required	Semantics
`lab`	str	no
`applied`	int	no
`skippedPrune`	int	no
`fullDeploy`	bool	no
`applicable`	bool	no
`summary`	`PlanSummary`	no
`operations`	list[`PlanAction`]	no
`blocked`	list[`PlanAction`]	no
`direction`	str	no	omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
`state`	Any	no
`yaml`	str	no
`files`	dict[str, str]	no
`source`	Any	no
`manifest`	str	no

Used by: reconcileProject

DestroyData¶

Field	Python type	Required	Semantics
`lab`	str	no

Used by: destroyProject

ProjectStatusData¶

Field	Python type	Required	Semantics
`mode`	str	no
`source_lab`	str	None	no
`managed_lab`	str	None	no
`runtime_lab`	str	None	no
`capabilities`	`ProjectModeCaps`	no
`locked`	bool	no
`lock`	int	no

Used by: getProjectStatus

InspectionData¶

Field	Python type	Required
`observation`	bool	no
`desired_state`	bool	no
`mode`	str	no
`source_lab`	Any	no
`managed_lab`	Any	no
`runtime_lab`	str	no
`capabilities`	`ProjectModeCaps`	no
`cached`	bool	no

Used by: inspectProject

OpenData¶

Field	Python type	Required
`url`	str	no
`ttl`	int	no
`lab`	str	no

Used by: openProject

ConsoleRecord¶

Field	Python type	Required
`id`	int	no
`key`	str	no
`name`	str	no
`template`	str	no
`console`	str	no
`status`	int	no
`url`	str	no

ConsolesData¶

Field	Python type	Required
`lab`	str	no
`html5`	bool	no
`consoles`	list[`ConsoleRecord`]	no

Used by: listProjectConsoles

ConsoleExecData¶

Field	Python type	Required	Semantics
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`name`	str	no
`console_type`	str	no
`command`	str	no
`output`	str	no
`duration_ms`	int	no

Used by: execConsole

ConsoleExecManyData¶

Field	Python type	Required	Semantics
`results`	list[Mapping[str, Any]]	no

Used by: execConsoleMany

ConsoleAttachData¶

Field	Python type	Required	Semantics
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`name`	str	no
`console_type`	str	no
`stream`	str	no
`transport`	Literal["eve-telnet"]	no

Used by: attachConsole

ListTemplatesQuery¶

Generated query object. Omit the whole argument to send no query string.

Field	Python type	Required	Semantics
`provisioned`	str	no	Only the string true filters to provisioned templates. Omitted means all.

Used by: listTemplates

CompleteLinkInterfacesRequest¶

Request body alias of AuthoringPayload. Same wire shape.

Alias of AuthoringPayload.

Field	Python type	Required	Semantics
`dir`	str	no	Rejected when non-empty.
`yaml`	str	no
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`template`	str	no
`attributes`	Mapping[str, Any]	no
`excludeUsed`	bool	no
`eth_format`	str	no

PreviewInterfacesRequest¶

Request body alias of AuthoringPayload. Same wire shape.

Alias of AuthoringPayload.

Field	Python type	Required	Semantics
`dir`	str	no	Rejected when non-empty.
`yaml`	str	no
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`template`	str	no
`attributes`	Mapping[str, Any]	no
`excludeUsed`	bool	no
`eth_format`	str	no

ValidateProjectRequest¶

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field	Python type	Required	Semantics
`lab`	str	no
`yaml`	str	no
`files`	dict[str, str]	no
`state`	Any	no
`source`	Any	no
`manifest`	str	no
`prune`	bool	no	omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
`wipe`	bool	no	explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
`action`	str	no
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`id`	int	no
`stopmode`	int	no	0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
`refresh`	bool	no	omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
`replace`	bool	no	omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
`plan_identity`	str	no	omitted: recompute the live plan. present: opaque token from the last plan of the same direction
`direction`	str	no	Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
`dir`	str	no	Rejected when non-empty.
`out`	str	no	Rejected when non-empty.

ImportProjectRequest¶

Request body for importProject.

Field	Python type	Required	Semantics
`lab`	str	yes
`yaml`	str	no
`files`	dict[str, str]	no
`state`	Any	no
`source`	Any	no
`manifest`	str	no
`prune`	bool	no	omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
`wipe`	bool	no	explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
`action`	str	no
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`id`	int	no
`stopmode`	int	no	0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
`refresh`	bool	no	omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
`replace`	bool	no	omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
`plan_identity`	str	no	omitted: recompute the live plan. present: opaque token from the last plan of the same direction
`direction`	str	no	Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
`dir`	str	no	Rejected when non-empty.
`out`	str	no	Rejected when non-empty.

Used by: importProject

DeployProjectRequest¶

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field	Python type	Required	Semantics
`lab`	str	no
`yaml`	str	no
`files`	dict[str, str]	no
`state`	Any	no
`source`	Any	no
`manifest`	str	no
`prune`	bool	no	omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
`wipe`	bool	no	explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
`action`	str	no
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`id`	int	no
`stopmode`	int	no	0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
`refresh`	bool	no	omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
`replace`	bool	no	omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
`plan_identity`	str	no	omitted: recompute the live plan. present: opaque token from the last plan of the same direction
`direction`	str	no	Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
`dir`	str	no	Rejected when non-empty.
`out`	str	no	Rejected when non-empty.

PlanProjectRequest¶

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field	Python type	Required	Semantics
`lab`	str	no
`yaml`	str	no
`files`	dict[str, str]	no
`state`	Any	no
`source`	Any	no
`manifest`	str	no
`prune`	bool	no	omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
`wipe`	bool	no	explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
`action`	str	no
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`id`	int	no
`stopmode`	int	no	0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
`refresh`	bool	no	omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
`replace`	bool	no	omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
`plan_identity`	str	no	omitted: recompute the live plan. present: opaque token from the last plan of the same direction
`direction`	str	no	Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
`dir`	str	no	Rejected when non-empty.
`out`	str	no	Rejected when non-empty.

ReconcileProjectRequest¶

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field	Python type	Required	Semantics
`lab`	str	no
`yaml`	str	no
`files`	dict[str, str]	no
`state`	Any	no
`source`	Any	no
`manifest`	str	no
`prune`	bool	no	omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
`wipe`	bool	no	explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
`action`	str	no
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`id`	int	no
`stopmode`	int	no	0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
`refresh`	bool	no	omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
`replace`	bool	no	omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
`plan_identity`	str	no	omitted: recompute the live plan. present: opaque token from the last plan of the same direction
`direction`	str	no	Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
`dir`	str	no	Rejected when non-empty.
`out`	str	no	Rejected when non-empty.

DestroyProjectRequest¶

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field	Python type	Required	Semantics
`lab`	str	no
`yaml`	str	no
`files`	dict[str, str]	no
`state`	Any	no
`source`	Any	no
`manifest`	str	no
`prune`	bool	no	omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
`wipe`	bool	no	explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
`action`	str	no
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`id`	int	no
`stopmode`	int	no	0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
`refresh`	bool	no	omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
`replace`	bool	no	omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
`plan_identity`	str	no	omitted: recompute the live plan. present: opaque token from the last plan of the same direction
`direction`	str	no	Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
`dir`	str	no	Rejected when non-empty.
`out`	str	no	Rejected when non-empty.

GetProjectStatusRequest¶

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field	Python type	Required	Semantics
`lab`	str	no
`yaml`	str	no
`files`	dict[str, str]	no
`state`	Any	no
`source`	Any	no
`manifest`	str	no
`prune`	bool	no	omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
`wipe`	bool	no	explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
`action`	str	no
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`id`	int	no
`stopmode`	int	no	0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
`refresh`	bool	no	omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
`replace`	bool	no	omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
`plan_identity`	str	no	omitted: recompute the live plan. present: opaque token from the last plan of the same direction
`direction`	str	no	Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
`dir`	str	no	Rejected when non-empty.
`out`	str	no	Rejected when non-empty.

InspectProjectRequest¶

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field	Python type	Required	Semantics
`lab`	str	no
`yaml`	str	no
`files`	dict[str, str]	no
`state`	Any	no
`source`	Any	no
`manifest`	str	no
`prune`	bool	no	omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
`wipe`	bool	no	explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
`action`	str	no
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`id`	int	no
`stopmode`	int	no	0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
`refresh`	bool	no	omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
`replace`	bool	no	omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
`plan_identity`	str	no	omitted: recompute the live plan. present: opaque token from the last plan of the same direction
`direction`	str	no	Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
`dir`	str	no	Rejected when non-empty.
`out`	str	no	Rejected when non-empty.

OpenProjectRequest¶

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field	Python type	Required	Semantics
`lab`	str	no
`yaml`	str	no
`files`	dict[str, str]	no
`state`	Any	no
`source`	Any	no
`manifest`	str	no
`prune`	bool	no	omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
`wipe`	bool	no	explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
`action`	str	no
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`id`	int	no
`stopmode`	int	no	0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
`refresh`	bool	no	omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
`replace`	bool	no	omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
`plan_identity`	str	no	omitted: recompute the live plan. present: opaque token from the last plan of the same direction
`direction`	str	no	Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
`dir`	str	no	Rejected when non-empty.
`out`	str	no	Rejected when non-empty.

ListProjectConsolesRequest¶

Request body alias of ProjectPayload. Same wire shape.

Alias of ProjectPayload.

Field	Python type	Required	Semantics
`lab`	str	no
`yaml`	str	no
`files`	dict[str, str]	no
`state`	Any	no
`source`	Any	no
`manifest`	str	no
`prune`	bool	no	omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
`wipe`	bool	no	explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
`action`	str	no
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`id`	int	no
`stopmode`	int	no	0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
`refresh`	bool	no	omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
`replace`	bool	no	omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
`plan_identity`	str	no	omitted: recompute the live plan. present: opaque token from the last plan of the same direction
`direction`	str	no	Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
`dir`	str	no	Rejected when non-empty.
`out`	str	no	Rejected when non-empty.

ExecProjectRequest¶

Request body for execProject.

Field	Python type	Required	Semantics
`lab`	str	no
`yaml`	str	no
`files`	dict[str, str]	no
`state`	Any	no
`source`	Any	no
`manifest`	str	no
`prune`	bool	no	omitted: Go bool zero = false; extras are not deleted. explicit false: same semantic as omitted, distinct on the wire. explicit true: delete extra live objects on to_eve
`wipe`	bool	no	explicit false: destroy lab without wiping nodes. omitted on destroy: server pointer nil means wipe nodes (true)
`action`	str	yes
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`id`	int	no
`stopmode`	int	no	0=graceful 1=poweroff 2=hibernate 3=auto. Omitted uses lifecycle.DefaultStopMode (3). Explicit 0 is graceful. No OpenAPI default. omitted: lifecycle.DefaultStopMode (3, Vue auto). explicit 0: graceful stop (0); distinct from omission. values: 0=graceful 1=poweroff 2=hibernate 3=auto
`refresh`	bool	no	omitted: Go bool zero = false; inspect may use the session cache. explicit true: bypass inspect cache
`replace`	bool	no	omitted: Go bool zero = false; existing managed lab returns 409 lab_exists. explicit true: stop/wipe/delete then recreate
`plan_identity`	str	no	omitted: recompute the live plan. present: opaque token from the last plan of the same direction
`direction`	str	no	Wire string. Valid values are documented in semantics.yaml, not as an OpenAPI enum, so omitted vs to_eve vs empty vs invalid remain distinct on the wire. omitted: resolves to to_eve. empty string: resolves to to_eve. from_eve is not Import
`dir`	str	no	Rejected when non-empty.
`out`	str	no	Rejected when non-empty.

Used by: execProject

ExecConsoleRequest¶

Request body alias of ConsolePayload. Same wire shape.

Alias of ConsolePayload.

Field	Python type	Required	Semantics
`lab`	str	no
`yaml`	str	no
`files`	dict[str, str]	no
`state`	Any	no
`manifest`	str	no
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`command`	str	no
`timeout_ms`	int	no
`targets`	list[`ConsoleTarget`]	no
`dir`	str	no	Rejected when non-empty.
`out`	str	no	Rejected when non-empty.

ExecConsoleManyRequest¶

Request body alias of ConsolePayload. Same wire shape.

Alias of ConsolePayload.

Field	Python type	Required	Semantics
`lab`	str	no
`yaml`	str	no
`files`	dict[str, str]	no
`state`	Any	no
`manifest`	str	no
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`command`	str	no
`timeout_ms`	int	no
`targets`	list[`ConsoleTarget`]	no
`dir`	str	no	Rejected when non-empty.
`out`	str	no	Rejected when non-empty.

AttachConsoleRequest¶

Request body alias of ConsolePayload. Same wire shape.

Alias of ConsolePayload.

Field	Python type	Required	Semantics
`lab`	str	no
`yaml`	str	no
`files`	dict[str, str]	no
`state`	Any	no
`manifest`	str	no
`node`	str	no	omitted: all nodes. empty string: all nodes. named: that IaC node key
`command`	str	no
`timeout_ms`	int	no
`targets`	list[`ConsoleTarget`]	no
`dir`	str	no	Rejected when non-empty.
`out`	str	no	Rejected when non-empty.