Blocks

stop instance

This block is part of the virtualisation group and was last modified in core v15.0.0.

LXD integration
stop instance v13.0.9 Updated v15.0.0

Stop a instance on the LXD server.

In pins 5 + flow
  • flow
  • Connection lxdconnection required

    The LXD connection

  • Instance name value required

    The name of the instance to stop.

  • Force condition

    If this boolean is true it will force the action.

  • Stateful condition

    If this boolean is true it will store the runtime state.

  • Timeout number

    How long to wait (in s) before giving up. Only can be used when forced is false.

Out pins 5 + flow
  • flow
  • Connection lxdconnection

    The LXD connection

  • Success condition

    If successful, this pin returns true.

  • Instance object

    The info of the instances that you stopped.

  • Operation value

    The ID of the operation that starts this instance.

  • Error value

    Error message if the instance could not be stipped.

A typical wiring for stop instance: a function trigger starts the flow; create network feeds the connection pin; value feeds the instance_name pin; the flow out pin feeds debug.

Studio canvas example for the stop instance block: typical wiring for stop instance.

Version history

Introduced in v13.0.9.

Last modified in v15.0.0.

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
View as Markdown Was this page helpful? Tell us what to improve