Nutanix StopVm

Nutanix StopVm
Certified
Enterprise Edition
Stop AHV VM (graceful or force)

Stop a Nutanix AHV VM via the VMM v4 API, optionally requesting a graceful shutdown (with or without Guest Tools); falls back to power-off and returns the async task extId.

yaml
type: io.kestra.plugin.ee.nutanix.ahv.StopVm

Examples

Stop an AHV VM

yaml
id: nutanix_stop_vm
namespace: company.team
tasks:
  - id: stop_vm
    type: io.kestra.plugin.ee.nutanix.ahv.StopVm
    host: "{{ secret('NUTANIX_HOST') }}"
    token: "{{ secret('NUTANIX_TOKEN') }}"
    vmExtId: "{{ secret('NUTANIX_VM_EXT_ID') }}"
    gracefully: true
    guest: true

Properties

host *string

Prism Central host

Required Nutanix Prism Central host or IP address.

vmExtId *string

VM extId

Required extId of the VM to stop.

gracefully booleanstring

Defaultfalse

Gracefully stop the VM

When true, request a graceful shutdown instead of a forced power-off; defaults to false.

guest booleanstring

Defaultfalse

Use guest tools for graceful shutdown

When true with gracefully, use Nutanix Guest Tools for the shutdown request; ignored if gracefully is false.

password string

Password

Prism Central password; required when no token is provided.

pluginDefaultsRef string

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

port integerstring

Default9440

Prism Central port

API port for Prism Central; defaults to 9440.

scheme string

Defaulthttps

Scheme

HTTP scheme (https default) for the Prism Central API.

token string

Bearer token

Bearer token for Prism Central; when set, username/password are optional.

username string

Username

Prism Central username; required when no token is provided.

verifySsl booleanstring

Defaulttrue

Verify SSL

Whether to verify SSL certificates; defaults to true. Disabling this (setting to false) causes the client to trust all certificates without validation, exposing connections to man-in-the-middle attacks. Only set to false for trusted, isolated test environments, never in production.

Outputs

taskExtId string

Task extId

ExtId of the asynchronous stop task.

timestamp integer

Timestamp

The timestamp (in milliseconds since epoch) when the operation completed.