ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Add partial doc on return value of virt (#2116)

Browse source
This commit is contained in:
Michael Scherer 2016-04-27 16:47:44 +02:00 committed by Matt Clay
parent e878cf43f6
commit 2ec17e4614
1 changed files with 17 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
lib/ansible/modules/extras/cloud/misc/virt.py
View file

@ -84,6 +84,23 @@ tasks:
virt: name=foo state=running uri=lxc:/// 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_FAILED = 1
VIRT_SUCCESS = 0 VIRT_SUCCESS = 0
VIRT_UNAVAILABLE=2 VIRT_UNAVAILABLE=2