REFERENCE.md

Reference

Table of Contents

Tasks

• delete: Delete Lima VM
• list: Return list of Lima VMs
• resolve_reference: Generate Bolt targets from Lima VMs
• start: Create or start Lima VM
• stop: Stop Lima VM

Plans

• lima::cluster::delete: Delete the cluster of Lima VMs
• lima::cluster::start: Create/start the cluster of Lima VMs
• lima::cluster::stop: Stop the cluster of Lima VMs
• lima::clusters: Return the cluster definition

Tasks

delete

Delete Lima VM

Supports noop? false

Parameters

limactl_path

Data type: Optional[String[1]]

Location of the limactl binary if not in PATH

name

Data type: String[1]

VM name

list

Return list of Lima VMs

Supports noop? false

Parameters

limactl_path

Data type: Optional[String[1]]

Location of the limactl binary if not in PATH

names

Data type: Optional[Array[String[1]]]

VM names to list

resolve_reference

Generate Bolt targets from Lima VMs

Supports noop? false

Parameters

limactl_path

Data type: Optional[String[1]]

Location of the limactl binary if not in PATH

only_matching_names

Data type: Optional[Pattern]

Only VM with names matching this regex will be included into the inventory.

except_matching_names

Data type: Optional[Pattern]

VMs with names matching this regex will be excluded from the inventory.

start

Create or start Lima VM

Supports noop? false

Parameters

limactl_path

Data type: Optional[String[1]]

Location of the limactl binary if not in PATH

name

Data type: String[1]

VM name

timeout

Data type: Optional[String[1]]

Duration to wait for the instance to be running before timing out

url

Data type: Optional[String[1]]

Remote URL containing YAML configuration to create the instance from

template

Data type: Optional[String[1]]

Lima template to create the instance from

config

Data type: Optional[Hash]

Configuration hash to create the instance from

stop

Stop Lima VM

Supports noop? false

Parameters

limactl_path

Data type: Optional[String[1]]

Location of the limactl binary if not in PATH

name

Data type: String[1]

VM name

Plans

lima::cluster::delete

Delete the cluster of Lima VMs

Parameters

The following parameters are available in the lima::cluster::delete plan:

• name
• clusters
• target

name

Data type: String[1]

Cluster name

clusters

Data type: Optional[Hash]

Hash of all defined clusters. Populated from Hiera usually.

Default value: undef

target

Data type: TargetSpec

The host to run the limactl on

Default value: 'localhost'

lima::cluster::start

Create/start the cluster of Lima VMs

Parameters

The following parameters are available in the lima::cluster::start plan:

• name
• clusters
• target

name

Data type: String[1]

Cluster name

clusters

Data type: Optional[Hash]

Hash of all defined clusters. Populated from Hiera usually.

Default value: undef

target

Data type: TargetSpec

The host to run the limactl on

Default value: 'localhost'

lima::cluster::stop

Stop the cluster of Lima VMs

Parameters

The following parameters are available in the lima::cluster::stop plan:

• name
• clusters
• target

name

Data type: String[1]

Cluster name

clusters

Data type: Optional[Hash]

Hash of all defined clusters. Populated from Hiera usually.

Default value: undef

target

Data type: TargetSpec

The host to run the limactl on

Default value: 'localhost'

lima::clusters

Return the cluster definition

Parameters

The following parameters are available in the lima::clusters plan:

• name
• clusters

name

Data type: String[1]

Cluster name

clusters

Data type: Hash

Hash of all defined clusters. Populated from Hiera usually.

Default value: lookup('lima::clusters', 'default_value' => {})