Update configuration with disk_ext option

This commit is contained in:
Brian Cain 2020-01-23 08:19:28 -08:00
parent 8654b2bb67
commit 8cd04db602
No known key found for this signature in database
GPG Key ID: 9FC4639B2E4510A0

View File

@ -29,9 +29,11 @@ Vagrant Disks has several options that allow users to define and attach disks to
## Disk Options
* `name` (string) - Optional argument to give the disk a name
* `type` (symbol) - The type of disk to manage. This option defaults to `:disk`. Please read the provider specific documentation for supported types.
* `disk_ext` (string) - Optional argument that defines what kind of file
extension a disk should have. For a list of supported disk extensions, please check
the specific provider being used.
* `file` (string) - Optional argument that defines a path on disk pointing to the location of a disk file.
* `name` (string) - Optional argument to give the disk a name
* `primary` (boolean) - Optional argument that configures a given disk to be the "primary" disk to manage on the guest. There can only be one `primary` disk per guest.
* `provider_config` (hash) - Additional provider specific options for managing a given disk.
@ -41,6 +43,7 @@ Vagrant Disks has several options that allow users to define and attach disks to
- The provider name followed by a double underscore, and then the provider specific option for that disk
+ `{providername: {diskoption: value}, otherprovidername: {diskoption: value}`
- A hash where the top level key(s) are one or more providers, and each provider keys values are a hash of options and their values.
* `type` (symbol) - The type of disk to manage. This option defaults to `:disk`. Please read the provider specific documentation for supported types.
**Note:** More specific examples of these can be found under the provider specific disk page. The `provider_config` option will depend on the provider you are using. Please read the provider specific documentation for disk management to learn about what options are available to use.