HPE Morpheus SnapshotVm
CertifiedEnterprise EditionManage VM snapshots on HPE Morpheus
HPE Morpheus SnapshotVm
Manage VM snapshots on HPE Morpheus
Create, revert, or delete snapshots for a Morpheus instance. Snapshot creation is asynchronous and can be waited on via polling.
type: io.kestra.plugin.ee.hpe.morpheus.SnapshotVmExamples
Create a snapshot of a Morpheus VM.
id: snapshot_morpheus_vm
namespace: company.team
tasks:
- id: create_snapshot
type: io.kestra.plugin.ee.hpe.morpheus.SnapshotVm
url: "{{ secret('MORPHEUS_URL') }}"
accessToken: "{{ secret('MORPHEUS_TOKEN') }}"
instanceId: 42
action: CREATE
snapshotName: "pre-deploy-snapshot"
snapshotDescription: "Snapshot before deployment"
wait: true
Revert a Morpheus VM to a snapshot.
id: revert_morpheus_vm
namespace: company.team
tasks:
- id: revert_snapshot
type: io.kestra.plugin.ee.hpe.morpheus.SnapshotVm
url: "{{ secret('MORPHEUS_URL') }}"
accessToken: "{{ secret('MORPHEUS_TOKEN') }}"
instanceId: 42
action: REVERT
snapshotId: 5
Delete a snapshot from a Morpheus VM.
id: delete_morpheus_snapshot
namespace: company.team
tasks:
- id: delete_snapshot
type: io.kestra.plugin.ee.hpe.morpheus.SnapshotVm
url: "{{ secret('MORPHEUS_URL') }}"
accessToken: "{{ secret('MORPHEUS_TOKEN') }}"
action: DELETE
snapshotId: 5
Properties
accessToken *string
Morpheus API access token
Bearer token sent as Authorization: Bearer <value> for all requests.
action *string
CREATEREVERTDELETEAction
The snapshot action to perform: CREATE, REVERT, or DELETE.
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
{}1150instanceId integerstring
Instance ID
The ID of the instance. Required for CREATE and REVERT actions.
maxWaitDuration string
PT15MMaximum wait duration
Maximum duration to wait for snapshot creation. Defaults to 15 minutes.
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.
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 snapshot creation. Defaults to 10 seconds.
snapshotDescription string
Snapshot description
Optional description for the snapshot (CREATE only).
snapshotId integerstring
Snapshot ID
The ID of the snapshot. Required for REVERT and DELETE actions.
snapshotName string
Snapshot name
Optional name for the snapshot (CREATE only). Defaults to {serverName}.{timestamp}.
wait booleanstring
trueWait for completion
Whether to wait for the snapshot operation to complete (CREATE only).
Outputs
instanceId integer
Instance ID
The ID of the instance (available for CREATE and REVERT).
snapshotId integer
Snapshot ID
The ID of the snapshot. Set for CREATE, REVERT, and DELETE actions.
success boolean
Success
Always true; the task throws an exception if the operation fails.
