Skip to content

Commit c02610a

Browse files
committed
Update documentation
1 parent 1802986 commit c02610a

File tree

1 file changed

+108
-0
lines changed

1 file changed

+108
-0
lines changed

REFERENCE.md

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,54 @@
66

77
### Tasks
88

9+
* [`delete`](#delete): Delete Lima VM
10+
* [`list`](#list): Return list of Lima VMs
911
* [`resolve_reference`](#resolve_reference): Generate Bolt targets from Lima VMs
12+
* [`start`](#start): Create or start Lima VM
13+
* [`stop`](#stop): Stop Lima VM
1014

1115
## Tasks
1216

17+
### <a name="delete"></a>`delete`
18+
19+
Delete Lima VM
20+
21+
**Supports noop?** false
22+
23+
#### Parameters
24+
25+
##### `limactl_path`
26+
27+
Data type: `Optional[String[1]]`
28+
29+
Location of the `limactl` binary if not in PATH
30+
31+
##### `name`
32+
33+
Data type: `String[1]`
34+
35+
VM name
36+
37+
### <a name="list"></a>`list`
38+
39+
Return list of Lima VMs
40+
41+
**Supports noop?** false
42+
43+
#### Parameters
44+
45+
##### `limactl_path`
46+
47+
Data type: `Optional[String[1]]`
48+
49+
Location of the `limactl` binary if not in PATH
50+
51+
##### `names`
52+
53+
Data type: `Optional[Array[String[1]]]`
54+
55+
VM names to list
56+
1357
### <a name="resolve_reference"></a>`resolve_reference`
1458

1559
Generate Bolt targets from Lima VMs
@@ -36,3 +80,67 @@ Data type: `Optional[Pattern]`
3680

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

83+
### <a name="start"></a>`start`
84+
85+
Create or start Lima VM
86+
87+
**Supports noop?** false
88+
89+
#### Parameters
90+
91+
##### `limactl_path`
92+
93+
Data type: `Optional[String[1]]`
94+
95+
Location of the `limactl` binary if not in PATH
96+
97+
##### `name`
98+
99+
Data type: `String[1]`
100+
101+
VM name
102+
103+
##### `timeout`
104+
105+
Data type: `Optional[String[1]]`
106+
107+
Duration to wait for the instance to be running before timing out
108+
109+
##### `url`
110+
111+
Data type: `Optional[String[1]]`
112+
113+
Remote URL containing YAML configuration to create the instance from
114+
115+
##### `template`
116+
117+
Data type: `Optional[String[1]]`
118+
119+
Lima template to create the instance from
120+
121+
##### `config`
122+
123+
Data type: `Optional[Hash]`
124+
125+
Configuration hash to create the instance from
126+
127+
### <a name="stop"></a>`stop`
128+
129+
Stop Lima VM
130+
131+
**Supports noop?** false
132+
133+
#### Parameters
134+
135+
##### `limactl_path`
136+
137+
Data type: `Optional[String[1]]`
138+
139+
Location of the `limactl` binary if not in PATH
140+
141+
##### `name`
142+
143+
Data type: `String[1]`
144+
145+
VM name
146+

0 commit comments

Comments
 (0)