RUAL Documentation

create instance

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

create instance v13.0.9

Creates a instance on the LXD server.

Pin Pin Type Default
flow
flow
Connectionrequired
The LXD connection
lxdconnection
Namerequired
The name of the instance to create.
value
Descriptionrequired
The description of the instance to create.
value
Instance Typerequired
Cloud instance type to emulate with limits.
value container
Typerequired
The type of the instance to create.
value
Configrequired
Array of all the configs to set, has to be array with objects that all have fields key and value.
array
Sourcerequired
Source represents the creation source for a new instance. Check the service documentation for the fields you can set.
object
Devicesrequired
Object with all the devices for the instance.
object
Profilesrequired
List of profiles applied to the instance.
array
Restore
If set, instance will be restored to the provided snapshot name.
value
Start after create
If this boolean is true the instance will start after it is created.
condition
Delete on shutdown
If this boolean is true the instance will be deleted after shutdown.
condition
Stateful
If this boolean is true the instance currently has saved state on disk.
condition
Pin Pin Type Example
flow
flow
Connectionrequired
The LXD connection
lxdconnection
Success
If successful, this pin returns true.
condition
Instance
The instance that you created.
object
Error
Error message if the instance could not be created.
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