Skip to content

Commit a36732e

Browse files
markgoddardgoetzk
authored andcommitted
Add documentation of volume type
1 parent 909217d commit a36732e

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,14 +75,15 @@ Role Variables
7575

7676
- `volumes`: a list of volumes to attach to the VM. Each volume is
7777
defined with the following dict:
78+
- `type`: Type of the volume. Options include `volume`, `file` and `network`.
7879
- `pool`: Name or UUID of the storage pool from which the volume should be
79-
allocated.
80+
allocated. Required when `type` is `volume`.
8081
- `name`: Name to associate with the volume being created; For `file` type volumes include extension if you would like volumes created with one.
8182
- `file_path`: Where the image of `file` type volumes should be placed; defaults to `libvirt_volume_default_images_path`
8283
- `device`: `disk` or `cdrom`
8384
- `capacity`: volume capacity, can be suffixed with k, M, G, T, P or E when type is `network` or MB,GB,TB, etc when type is `disk` (required when type is `disk` or `network`)
8485
- `auth`: Authentication details should they be required. If auth is required, `name`, `type`, `token` will need to be supplied.
85-
- `source`: Where the remote volume comes from. `protocol`, `name`, `hostname` and `port` should be supplied.
86+
- `source`: Where the remote volume comes from when type is `network`. `protocol`, `name`, `hostname` and `port` should be supplied.
8687
- `format`: options include `raw`, `qcow2`, `vmdk`. See `man virsh` for the
8788
full range. Default is `qcow2`.
8889
- `image`: (optional) a URL to an image with which the volume is initalised (full copy).

0 commit comments

Comments
 (0)