DeleteVmSnapshot

This plugin is currently in beta. While it is considered safe for use, please be aware that its API could change in ways that are not compatible with earlier versions in future releases, or it might become unsupported.

Delete a snapshot of a virtual machine on vCenter.

This task deletes a named snapshot of a virtual machine in a vCenter-managed environment.

yaml
type: "io.kestra.plugin.ee.vmware.vcenter.DeleteVmSnapshot"

Examples

Delete a VM snapshot by name

yaml
id: delete_vm_snapshot
namespace: company.team

tasks:
  - id: deleteSnapshot
    type: io.kestra.plugin.ee.vmware.vcenter.DeleteVmSnapshot
    server: "vcenter.mycompany.com"
    username: "{{ secret('VMWARE_VCENTER_USERNAME') }}"
    password: "{{ secret('VMWARE_VCENTER_PASSWORD') }}"
    vmName: "vm-to-snapshot"
    snapshotName: "daily-backup-2025-07-18"

Properties

password *string

The password for authentication.

The password used to authenticate with the VMware server.

server *string

The URL of the server.

The URL to connect to the VMwareserver. This is a FQDN or an IP address (eg: esxi.mycompany.com), so without any protocol nor port.

snapshotName *string

The name of the snapshot to delete.

username *string

The username for authentication.

The username used to authenticate with the server. It could be something like '[email protected]' for vCenter or 'root' for ESXi.

vmName *string

The name of the virtual machine.

port integerstring

Default 443

The port for the connection.

The port to connect to the server. Default is 443.

removeChildren booleanstring

Default false

Whether to remove child snapshots.

If true, child snapshots will also be removed. Default: false.

trustStorePath string

The path to the trust store file.

The path to the trust store file containing certificates for secure connections. If not provided, an empty keystore will be created and the connection will be insecure.

​Delete​Vm​Snapshot

DeleteVmSnapshot