create instance

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

create instance v13.0.9 Updated v15.0.0

Creates a instance on the LXD server.

In pins 13 + flow
  • flow
    flow
  • Connection required
    lxdconnection

    The LXD connection

  • Name required
    value

    The name of the instance to create.

  • Description required
    value

    The description of the instance to create.

  • Instance Type required
    value

    Cloud instance type to emulate with limits.

    Default container

  • Type required
    value

    The type of the instance to create.

  • Config required
    array

    Array of all the configs to set, has to be array with objects that all have fields key and value.

  • Source required
    object

    Source represents the creation source for a new instance. Check the service documentation for the fields you can set.

  • Devices required
    object

    Object with all the devices for the instance.

  • Profiles required
    array

    List of profiles applied to the instance.

  • Restore
    value

    If set, instance will be restored to the provided snapshot name.

  • Start after create
    condition

    If this boolean is true the instance will start after it is created.

  • Delete on shutdown
    condition

    If this boolean is true the instance will be deleted after shutdown.

  • Stateful
    condition

    If this boolean is true the instance currently has saved state on disk.

Out pins 4 + flow
  • flow
    flow
  • Connection
    lxdconnection

    The LXD connection

  • Success
    condition

    If successful, this pin returns true.

  • Instance
    object

    The instance that you created.

  • Error
    value

    Error message if the instance could not be created.

A typical wiring for create instance: a function trigger starts the flow; create network feeds the connection pin; value feeds the name pin; value feeds the description pin; value feeds the instance_type pin; value feeds the type pin; with values feeds the config pin; new object feeds the source pin; new object feeds the devices pin; with values feeds the profiles pin; the flow out pin feeds debug.

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

Version history

Introduced in v13.0.9.

Last modified in v15.0.0.

Service documentation

External API reference This block wraps a third-party service. Click here for the service's own documentation of the underlying endpoint.
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