diff --git a/README.md b/README.md index c5e68bb2cb757b6f3d89247fe6a7b67c2e8a7cc4..1a6793e32be2c2f50b9db33c3c3769c4f1f73b05 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,27 @@ This is useful for specifying things like `disk.enableUUID=true` or `svga.autode Follow the Foreman manual for [advanced installation from gems](https://theforeman.org/plugins/#2.3AdvancedInstallationfromGems) +## Usage + +Create a configuration file in the Foreman config folder - e.g. `/etc/foreman/plugins/foreman_vmware_advanced.yaml` +In there you can configure any of the values managed by the plugin; + +```yaml +--- +# Additional VMX options +:vmware_advanced: + bios.bootOrder: ethernet0,hdd + disk.EnableUUID: 'TRUE' + svga.autodetect: 'TRUE' + tools.upgrade.policy: upgradeAtPowerCycle + +# Enable secureboot on new Windows UEFI VMs +:vmware_secureboot: true +# Attach a vTPM to all new VMs +:vmware_vtpm: true +``` + + ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/ananace/foreman_vmware_advanced