From 2ec17e4614fd73e30dd05506fd1f12cd2832de0f Mon Sep 17 00:00:00 2001 From: Michael Scherer Date: Wed, 27 Apr 2016 16:47:44 +0200 Subject: [PATCH] Add partial doc on return value of virt (#2116) --- lib/ansible/modules/extras/cloud/misc/virt.py | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/lib/ansible/modules/extras/cloud/misc/virt.py b/lib/ansible/modules/extras/cloud/misc/virt.py index 65791e43e9f..be1a7f9ec62 100644 --- a/lib/ansible/modules/extras/cloud/misc/virt.py +++ b/lib/ansible/modules/extras/cloud/misc/virt.py @@ -84,6 +84,23 @@ tasks: virt: name=foo state=running uri=lxc:/// ''' +RETURN = ''' +# for list_vms command +list_vms: + description: The list of vms defined on the remote system + type: dictionary + returned: success + sample: [ + "build.example.org", + "dev.example.org" + ] +# for status command +status: + description: The status of the VM, among running, crashed, paused and shutdown + type: string + sample: "success" + returned: success +''' VIRT_FAILED = 1 VIRT_SUCCESS = 0 VIRT_UNAVAILABLE=2