From 7fee01bb0ec540871d8b4651fe99168a360b0bef Mon Sep 17 00:00:00 2001 From: Rene Moser Date: Tue, 26 May 2015 13:52:47 +0200 Subject: [PATCH] proxmox: update module doc --- .../modules/extras/cloud/misc/proxmox.py | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/lib/ansible/modules/extras/cloud/misc/proxmox.py b/lib/ansible/modules/extras/cloud/misc/proxmox.py index 9742f95ba50..74c49afef92 100644 --- a/lib/ansible/modules/extras/cloud/misc/proxmox.py +++ b/lib/ansible/modules/extras/cloud/misc/proxmox.py @@ -25,12 +25,10 @@ options: api_host: description: - the host of the Proxmox VE cluster - default: null required: true api_user: description: - the user to authenticate with - default: null required: true api_password: description: @@ -52,26 +50,26 @@ options: node: description: - Proxmox VE node, when new VM will be created - - required only for state="present" + - required only for C(state=present) - for another states will be autodiscovered default: null required: false password: description: - the instance root password - - required only for state="present" + - required only for C(state=present) default: null required: false hostname: description: - the instance hostname - - required only for state="present" + - required only for C(state=present) default: null required: false ostemplate: description: - the template for VM creating - - required only for state="present" + - required only for C(state=present) default: null required: false disk: @@ -145,9 +143,9 @@ options: force: description: - forcing operations - - can be used only with states "present", "stopped", "restarted" - - with state="present" force option allow to overwrite existing container - - with states "stopped", "restarted" allow to force stop instance + - can be used only with states C(present), C(stopped), C(restarted) + - with C(state=present) force option allow to overwrite existing container + - with states C(stopped) , C(restarted) allow to force stop instance default: false required: false type: boolean @@ -159,7 +157,7 @@ options: notes: - Requires proxmoxer and requests modules on host. This modules can be installed with pip. requirements: [ "proxmoxer", "requests" ] -author: Sergei Antipov +author: "Sergei Antipov @UnderGreen" ''' import os