From eae81e36fd9a2eb9cd1c0ec1734cc7faba51f0df Mon Sep 17 00:00:00 2001 From: Ken Dreyer Date: Mon, 10 Dec 2018 10:29:34 -0700 Subject: [PATCH] openstack: document RETURNS for os_volume (#49559) Document the "id" and "volume" return values from the os_volume module. --- lib/ansible/modules/cloud/openstack/os_volume.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/lib/ansible/modules/cloud/openstack/os_volume.py b/lib/ansible/modules/cloud/openstack/os_volume.py index 034b499b62d..8d84b2eb7bb 100644 --- a/lib/ansible/modules/cloud/openstack/os_volume.py +++ b/lib/ansible/modules/cloud/openstack/os_volume.py @@ -78,6 +78,20 @@ EXAMPLES = ''' scheduler_hints: same_host: 243e8d3c-8f47-4a61-93d6-7215c344b0c0 ''' + +RETURNS = ''' +id: + description: Cinder's unique ID for this volume + returned: always + type: str + sample: fcc4ac1c-e249-4fe7-b458-2138bfb44c06 + +volume: + description: Cinder's representation of the volume object + returned: always + type: dict + sample: {'...'} +''' from distutils.version import StrictVersion