HPE Morpheus CreateVm
CertifiedEnterprise EditionCreate a VM instance on HPE Morpheus
HPE Morpheus CreateVm
Create a VM instance on HPE Morpheus
Provisions a new instance via the Morpheus API (POST /api/instances). Supports waiting for the instance to reach a running state via polling.
type: io.kestra.plugin.ee.hpe.morpheus.CreateVmExamples
Provision a new VM on HPE Morpheus.
id: create_morpheus_vm
namespace: company.team
tasks:
- id: create_vm
type: io.kestra.plugin.ee.hpe.morpheus.CreateVm
url: "{{ secret('MORPHEUS_URL') }}"
accessToken: "{{ secret('MORPHEUS_TOKEN') }}"
name: "my-new-vm"
instanceTypeCode: "ubuntu"
groupId: 1
cloudId: 6
planId: 75
layoutId: 105
wait: true
Properties
accessToken *string
Morpheus API access token
Bearer token sent as Authorization: Bearer <value> for all requests.
cloudId *integerstring
Cloud ID
The ID of the cloud (zone) to provision the instance into.
groupId *integerstring
Group ID
The ID of the group (site) to provision the instance into.
instanceTypeCode *string
Instance type code
The instance type code (for example: ubuntu, centos, nginx).
layoutId *integerstring
Layout ID
The ID of the instance layout to use. This determines the technology stack (e.g., HVM/KVM).
name *string
Instance name
planId *integerstring
Plan ID
The ID of the service plan to use for the instance.
url *string
Morpheus base URL
Base URL of the HPE Morpheus instance (for example: https://morpheus.example.com). Must be reachable from the worker; trailing slash is optional.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150config object
Cloud-specific config
Cloud-specific configuration object passed directly to the Morpheus API.
description string
Instance description
Optional description for the instance.
environment string
Environment
Optional environment context (for example: dev, staging, production).
labels array
Labels
Optional list of labels to apply to the instance.
maxWaitDuration string
PT30MMaximum wait duration
Maximum duration to wait for the instance to become running. Defaults to 30 minutes.
networkInterfaces array
Network interfaces
Optional network interface configuration.
options
HTTP client configuration
Optional HTTP client overrides (timeouts, TLS, proxies). Uses platform defaults when omitted.
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
Retry strategy for HTTP requests.
retry is disabled by default.
Constant retry
Retry with a fixed delay between attempts.
durationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalseExponential retry
Retry with exponentially increasing delays between attempts.
durationdurationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalseRandom retry
Retry with a random delay within a configurable range between attempts.
durationdurationRETRY_FAILED_TASKRETRY_FAILED_TASKCREATE_NEW_EXECUTION>= 1durationfalse[502,503,504]HTTP status codes that should be retried.
Used for idempotent methods (GET, HEAD) without their own entry in retryOnStatusCodesByMethod. Non-idempotent methods are never retried on a status code unless listed in retryOnStatusCodesByMethod. Defaults to 502, 503 and 504 for idempotent methods (GET, HEAD) only.
Per-HTTP-method overrides for which status codes should be retried.
Keys are HTTP methods (e.g. GET, POST). A method with no entry here falls back to retryOnStatusCodes. This lets a caller retry more broadly for safe, read-only methods (for example, every 5xx and a 429 for GET/HEAD) while keeping a narrower list for methods that write, where retrying a request that may have already been processed by the origin risks duplicating the effect. Example: {GET: [429, 500, 502, 503, 504], HEAD: [429, 500, 502, 503, 504]}.
["GET","HEAD"]HTTP methods for which any transport-level failure may be retried.
A transport-level failure is a connection or timeout error rather than an HTTP response (e.g. a read timeout or a connection reset mid-request). For a method listed here, any such failure is retried. Defaults to GET and HEAD HTTP methods.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
pollInterval string
PT10SPoll interval
Duration between status polls when waiting for completion. Defaults to 10 seconds.
volumes array
Volumes
Optional volume/storage configuration.
wait booleanstring
trueWait for completion
Whether to wait for the instance to reach a running state before completing the task.
Outputs
instanceId integer
Instance ID
The ID of the created instance.
name string
Instance name
The name of the created instance.
status string
Instance status
The final status of the instance.
