Data models
VMs
This data model describes virtual machines created by Steep’s cloud manager.
| Property | Type | Description |
|---|---|---|
| id (required) | string | A unique VM identifier |
| externalId (optional) | string | An identifier generated by the cloud platform |
| ipAddress (optional) | string | The VM’s IP address |
| setup (required) | object | The setup used to create this VM |
| creationTime (optional) | string | An ISO 8601 timestamp denoting the date and time when the VM was created. This property is null if the VM has not been created yet. |
| agentJoinTime (optional) | string | An ISO 8601 timestamp denoting the date and time when a Steep agent has been deployed to the VM and has joined the cluster. This property is null if the agent has not joined the cluster yet. |
| destructionTime (optional) | string | An ISO 8601 timestamp denoting the date and time when the VM was destroyed. This property is null if the VM has not been destroyed yet. |
| status (required) | string | The status of the VM |
| reason (optional) | string | The reason why the VM has the current status (e.g. an error message if it has the ERROR status or a simple message indicating why it has been DESTROYED) |
VM status
The following table shows the statuses a VM can have:
| Status | Description |
|---|---|
CREATING | The VM is currently being created |
PROVISIONING | The VM has been created and is currently being provisioned (i.e. provisioning scripts defined in the VM’s setup are being executed and the Steep agent is being deployed) |
RUNNING | The VM has been created and provisioned successfully. It is currently running and registered as a remote agent. |
LEFT | The remote agent on this VM has left. It will be destroyed eventually. |
DESTROYING | The VM is currently being destroyed |
DESTROYED | The VM has been destroyed |
ERROR | The VM could not be created, provisioned, or it failed otherwise. See the VM’s reason property for more information. |