From 98b2d04348e9d25c79b6982982b0f81bea6d3fa2 Mon Sep 17 00:00:00 2001 From: Wesley P <68830971+xhk416x@users.noreply.github.com> Date: Wed, 20 Dec 2023 01:30:17 -0500 Subject: [PATCH] Updated documentation to reflect new behaviour (#7685) * Updated documentation to reflect new behaviour Per issue [6027](https://github.com/ansible-collections/community.general/issues/6027), disk and storage should not be used together, and changes to the API make it so "disk" should be formatted like ":". Documentation edited to reflect this new behavior. * Apply suggestions from code review Change format due to referencing options. Co-authored-by: Felix Fontein --------- Co-authored-by: Felix Fontein --- plugins/modules/proxmox.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/plugins/modules/proxmox.py b/plugins/modules/proxmox.py index 90d8078a02..f47ae26e10 100644 --- a/plugins/modules/proxmox.py +++ b/plugins/modules/proxmox.py @@ -48,6 +48,7 @@ options: [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=])." - See U(https://pve.proxmox.com/wiki/Linux_Container) for a full description. - This option has no default unless O(proxmox_default_behavior) is set to V(compatibility); then the default is V(3). + - Should not be used in conjunction with O(storage). type: str cores: description: @@ -96,6 +97,7 @@ options: storage: description: - target storage + - Should not be used in conjunction with O(disk). type: str default: 'local' ostype: @@ -248,6 +250,18 @@ EXAMPLES = r''' hostname: example.org ostemplate: 'local:vztmpl/ubuntu-14.04-x86_64.tar.gz' +- name: Create new container with minimal options specifying disk storage location and size + community.general.proxmox: + vmid: 100 + node: uk-mc02 + api_user: root@pam + api_password: 1q2w3e + api_host: node1 + password: 123456 + hostname: example.org + ostemplate: 'local:vztmpl/ubuntu-14.04-x86_64.tar.gz' + disk: 'local-lvm:20' + - name: Create new container with hookscript and description community.general.proxmox: vmid: 100