stop instance

This block is part of the virtualisation group and was last modified in core v13.0.9.

stop instance lxdconnection v13.0.9

Stop a instance on the LXD server.

Pin	Pin	Type	Default
flow	`flow`
Connection`required` The LXD connection	`lxdconnection`
Instance name`required` The name of the instance to stop.	`value`
Force If this boolean is true it will force the action.	`condition`
Stateful If this boolean is true it will store the runtime state.	`condition`
Timeout How long to wait (in s) before giving up. Only can be used when forced is false.	`number`

Pin	Pin	Type	Example
flow	`flow`
Connection`required` The LXD connection	`lxdconnection`
Success If successful, this pin returns true.	`condition`
Instance The info of the instances that you stopped.	`object`
Operation The ID of the operation that starts this instance.	`value`
Error Error message if the instance could not be stipped.	`value`

Core Releases

v13.0.9 This block was introduced in v13.0.9, click here to see the release notes.

Back to virtualisation Return to the main group to view all sub-groups Back to LXD Return to the group to view all blocks within this group