gcp.compute.vm.describe

Describe one GCE VM by name and zone without creating or mutating resources.

Describe one GCE VM by name and zone, optionally including serial output.

Overview

Property	Value
Workflow type	Linear
Library	Base-gcp
Version	1.0

Input Schema

Field	Type	Required	Default	Description
connection_uuid	uuid	Yes	—	GCP CloudConnection UUID.
name	string	Yes	—	VM instance name.
region	string	Yes	—	GCP zone; kept as region to match existing LTIP VM primitives.
project_id	string	No	—	Explicit GCP project override.
include_serial_port_output	boolean	No	—	Include Compute Engine serial port output.
serial_port	integer	No	—	Serial port number to read; defaults to provider API default.
serial_port_start	integer	No	—	Byte offset for serial output pagination.

Output Schema

Field	Type	Required	Default	Description
connection_uuid	uuid	No	—	GCP CloudConnection UUID echoed from input.
project_id	string	No	—	Resolved GCP project.
name	string	No	—	VM instance name.
region	string	No	—	GCP zone.
found	boolean	No	—	Whether the VM exists.
include_serial_port_output	boolean	No	—	Whether serial output was requested.
serial_port	integer	No	—	Serial port number requested.
serial_port_start	integer	No	—	Serial output byte offset requested.
provider_resource_id	string	No	—	Provider self link or resource ID.
status	string	No	—	Provider VM status.
private_ip	string	No	—	Primary internal IP.
public_ip	string	No	—	Primary external IP if present.
machine_type	string	No	—	Machine type.
serial_port_output	string	No	—	Serial port output contents when requested.
serial_port_next	string	No	—	Next serial output offset when returned by GCP.
metadata	json	No	—	Compatibility metadata including serial_port_output.
vm	json	No	—	Sanitized provider VM object.
failure_reason	string	No	—	Human-readable failure reason.
failed_step	string	No	—	Failed logical step.
failed_layer	json	No	—	Engine failed layer if applicable.
failed_at_state	string	No	—	State where failure occurred.
error	string	No	—	Error message.
error_type	string	No	—	Error class.
failed_at	string	No	—	ISO failure timestamp.

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	preflight	—
executing	No	No	—	complete	—
preflighting	No	No	—	execute	—
completed	No	Yes	Yes	—	—
failed	No	Yes	No	—	—

State Diagram

Transitions

From	Action	To	Description
pending	preflight	preflighting	—
preflighting	execute	executing	—
executing	complete	completed	—
* (any state)	fail	failed	—

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "gcp.compute.vm.describe",
  "initial_data": {
    "connection_uuid": "value",
    "name": "value",
    "region": "value"
  }
}