diff options
| author | Michael Scherer <mscherer@users.noreply.github.com> | 2016-04-27 16:47:44 +0200 |
|---|---|---|
| committer | Brian Coca <bcoca@ansible.com> | 2016-04-27 10:47:44 -0400 |
| commit | 95018b5fe89911924eec18265a9659fb5b03eea7 (patch) | |
| tree | 303fc41e7d72b201fb6ed273cc03a7113021b465 | |
| parent | 0b66156f25f54a7855c7e92fdb938a86a479d87b (diff) | |
| download | ansible-modules-extras-95018b5fe89911924eec18265a9659fb5b03eea7.tar.gz | |
Add partial doc on return value of virt (#2116)
| -rw-r--r-- | cloud/misc/virt.py | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/cloud/misc/virt.py b/cloud/misc/virt.py index 65791e43..be1a7f9e 100644 --- a/cloud/misc/virt.py +++ b/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 |