
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 *Requiredstring
Morpheus API access token
Bearer token sent as Authorization: Bearer <value> for all requests.
cloudId *Requiredintegerstring
Cloud ID
The ID of the cloud (zone) to provision the instance into.
groupId *Requiredintegerstring
Group ID
The ID of the group (site) to provision the instance into.
instanceTypeCode *Requiredstring
Instance type code
The instance type code (for example: ubuntu, centos, nginx).
layoutId *Requiredintegerstring
Layout ID
The ID of the instance layout to use. This determines the technology stack (e.g., HVM/KVM).
name *Requiredstring
Instance name
planId *Requiredintegerstring
Plan ID
The ID of the service plan to use for the instance.
url *Requiredstring
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.
config 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.
networkInterfaces array
Network interfaces
Optional network interface configuration.
options Non-dynamic
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.
The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
durationThe time allowed to establish a connection to the server before failing.
durationThe time an idle connection can remain in the client's connection pool before being closed.
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.
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDThe log level for the HTTP client.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The maximum content length of the response.
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.
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
durationThe time allowed for a read connection to remain idle before closing it.
durationThe maximum time allowed for reading data from the server before failing.
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.
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
pollInterval string
PT10SPoll interval
Duration between status polls when waiting for completion.
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.