HPE Morpheus CreateVm

HPE Morpheus CreateVm

Certified
Enterprise Edition

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.

yaml
type: io.kestra.plugin.ee.hpe.morpheus.CreateVm

Provision a new VM on HPE Morpheus.

yaml
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

Morpheus API access token

Bearer token sent as Authorization: Bearer <value> for all requests.

Cloud ID

The ID of the cloud (zone) to provision the instance into.

Group ID

The ID of the group (site) to provision the instance into.

Instance type code

The instance type code (for example: ubuntu, centos, nginx).

Layout ID

The ID of the instance layout to use. This determines the technology stack (e.g., HVM/KVM).

Instance name

Plan ID

The ID of the service plan to use for the instance.

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.

Cloud-specific config

Cloud-specific configuration object passed directly to the Morpheus API.

Instance description

Optional description for the instance.

Environment

Optional environment context (for example: dev, staging, production).

SubTypestring

Labels

Optional list of labels to apply to the instance.

DefaultPT30M

Maximum wait duration

Maximum duration to wait for the instance to become running.

SubTypeobject

Network interfaces

Optional network interface configuration.

HTTP client configuration

Optional HTTP client overrides (timeouts, TLS, proxies). Uses platform defaults when omitted.

Definitions
allowFailedbooleanstring
Defaultfalse

If true, allow a failed response code (response code >= 400)

allowedResponseCodesarray
SubTypeinteger

List of response code allowed for this request

auth

The authentication to use.

type*Requiredobject
passwordstring

The password for HTTP basic authentication.

usernamestring

The username for HTTP basic authentication.

type*Requiredobject
tokenstring

The token for bearer token authentication.

type*Requiredobject
passwordstring

The password for HTTP Digest authentication.

usernamestring

The username for HTTP Digest authentication.

basicAuthPasswordDeprecatedstring

The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

basicAuthUserDeprecatedstring

The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

connectTimeoutDeprecatedstring
Formatduration

The time allowed to establish a connection to the server before failing.

connectionPoolIdleTimeoutDeprecatedstring
Formatduration

The time an idle connection can remain in the client's connection pool before being closed.

defaultCharsetstring
DefaultUTF-8

The default charset for the request.

enabledTcpExtendedKeepAlivebooleanstring
Defaulttrue

Whether 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.

followRedirectsbooleanstring
Defaulttrue

Whether redirects should be followed automatically.

logLevelDeprecatedstring
Possible Values
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIED

The log level for the HTTP client.

logsarray
SubTypestring
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

maxContentLengthDeprecatedinteger

The maximum content length of the response.

proxy

The proxy configuration.

addressstring

The address of the proxy server.

passwordstring

The password for proxy authentication.

portintegerstring

The port of the proxy server.

typestring
DefaultDIRECT
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

usernamestring

The username for proxy authentication.

proxyAddressDeprecatedstring

The address of the proxy server.

proxyPasswordDeprecatedstring

The password for proxy authentication.

proxyPortDeprecatedinteger

The port of the proxy server.

proxyTypeDeprecatedstring
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

proxyUsernameDeprecatedstring

The username for proxy authentication.

readIdleTimeoutDeprecatedstring
Formatduration

The time allowed for a read connection to remain idle before closing it.

readTimeoutDeprecatedstring
Formatduration

The maximum time allowed for reading data from the server before failing.

ssl

The SSL request options

insecureTrustAllCertificatesbooleanstring

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.

timeout

The timeout configuration.

connectTimeoutstring

The time allowed to establish a connection to the server before failing.

readIdleTimeoutstring
DefaultPT5M

The time allowed for a read connection to remain idle before closing it.

Reference (ref) of the pluginDefaults to apply to this task.

DefaultPT10S

Poll interval

Duration between status polls when waiting for completion.

SubTypeobject

Tags

Optional name/value tags to apply to the instance.

SubTypeobject

Volumes

Optional volume/storage configuration.

Defaulttrue

Wait for completion

Whether to wait for the instance to reach a running state before completing the task.

Instance ID

The ID of the created instance.

Instance name

The name of the created instance.

Instance status

The final status of the instance.