Fixed docs for cloud modules (#23745)

* Fixed docs for cloud modules

* removed blank line in ec2_snapshot_facts

lib/ansible/modules/cloud/openstack/os_flavor_facts.py

@@ -135,7 +135,7 @@ RETURN = '''
 openstack_flavors:
     description: Dictionary describing the flavors.
     returned: On success.
-    type: dictionary
+    type: complex
     contains:
         id:
             description: Flavor ID.

lib/ansible/modules/cloud/openstack/os_group.py

@@ -87,7 +87,7 @@ RETURN = '''
 group:
     description: Dictionary describing the group.
     returned: On success when I(state) is 'present'.
-    type: dictionary
+    type: complex
     contains:
         id:
             description: Unique group ID

lib/ansible/modules/cloud/openstack/os_ironic_inspect.py

@@ -71,7 +71,7 @@ RETURN = '''
 ansible_facts:
     description: Dictionary of new facts representing discovered properties of the node..
     returned: changed
-    type: dictionary
+    type: complex
     contains:
         memory_mb:
             description: Amount of node memory as updated in the node properties

lib/ansible/modules/cloud/openstack/os_keystone_domain.py

@@ -80,7 +80,7 @@ RETURN = '''
 domain:
     description: Dictionary describing the domain.
     returned: On success when I(state) is 'present'
-    type: dictionary
+    type: complex
     contains:
         id:
             description: Domain ID.

lib/ansible/modules/cloud/openstack/os_keystone_role.py

@@ -65,7 +65,7 @@ RETURN = '''
 role:
     description: Dictionary describing the role.
     returned: On success when I(state) is 'present'.
-    type: dictionary
+    type: complex
     contains:
         id:
             description: Unique role ID.

lib/ansible/modules/cloud/openstack/os_keystone_service.py

@@ -83,7 +83,7 @@ RETURN = '''
 service:
     description: Dictionary describing the service.
     returned: On success when I(state) is 'present'
-    type: dictionary
+    type: complex
     contains:
         id:
             description: Service ID.

lib/ansible/modules/cloud/openstack/os_network.py

@@ -103,7 +103,7 @@ RETURN = '''
 network:
     description: Dictionary describing the network.
     returned: On success when I(state) is 'present'.
-    type: dictionary
+    type: complex
     contains:
         id:
             description: Network ID.

lib/ansible/modules/cloud/openstack/os_nova_flavor.py

@@ -130,7 +130,7 @@ RETURN = '''
 flavor:
     description: Dictionary describing the flavor.
     returned: On success when I(state) is 'present'
-    type: dictionary
+    type: complex
     contains:
         id:
             description: Flavor ID.

lib/ansible/modules/cloud/openstack/os_port.py

@@ -186,7 +186,7 @@ network_id:
 security_groups:
     description: Security group(s) associated with this port.
     returned: success
-    type: list of strings
+    type: list
 status:
     description: Port's status.
     returned: success
@@ -194,7 +194,7 @@ status:
 fixed_ips:
     description: Fixed ip(s) associated with this port.
     returned: success
-    type: list of dicts
+    type: list
 tenant_id:
     description: Tenant id associated with this port.
     returned: success
@@ -202,7 +202,7 @@ tenant_id:
 allowed_address_pairs:
     description: Allowed address pairs with this port.
     returned: success
-    type: list of dicts
+    type: list
 admin_state_up:
     description: Admin state up flag for this port.
     returned: success

lib/ansible/modules/cloud/openstack/os_project.py

@@ -90,7 +90,7 @@ RETURN = '''
 project:
     description: Dictionary describing the project.
     returned: On success when I(state) is 'present'
-    type: dictionary
+    type: complex
     contains:
         id:
             description: Project ID

lib/ansible/modules/cloud/openstack/os_quota.py

@@ -241,48 +241,48 @@ RETURN = '''
 openstack_quotas:
     description: Dictionary describing the project quota.
     returned: Regardless if changes where made or note
-    type: dictionary
-    contains example:
-    "openstack_quotas": {
-        "compute": {
-            "cores": 150,
-            "fixed_ips": -1,
-            "floating_ips": 10,
-            "injected_file_content_bytes": 10240,
-            "injected_file_path_bytes": 255,
-            "injected_files": 5,
-            "instances": 100,
-            "key_pairs": 100,
-            "metadata_items": 128,
-            "ram": 153600,
-            "security_group_rules": 20,
-            "security_groups": 10,
-            "server_group_members": 10,
-            "server_groups": 10
-        },
-        "network": {
-            "floatingip": 50,
-            "network": 10,
-            "port": 160,
-            "rbac_policy": 10,
-            "router": 10,
-            "security_group": 10,
-            "security_group_rule": 100,
-            "subnet": 10,
-            "subnetpool": -1
-        },
-        "volume": {
-            "backup_gigabytes": 1000,
-            "backups": 10,
-            "gigabytes": 1000,
-            "gigabytes_lvm": -1,
-            "per_volume_gigabytes": -1,
-            "snapshots": 10,
-            "snapshots_lvm": -1,
-            "volumes": 10,
-            "volumes_lvm": -1
+    type: complex
+    contains:
+        openstack_quotas: {
+            compute: {
+                cores: 150,
+                fixed_ips: -1,
+                floating_ips: 10,
+                injected_file_content_bytes: 10240,
+                injected_file_path_bytes: 255,
+                injected_files: 5,
+                instances: 100,
+                key_pairs: 100,
+                metadata_items: 128,
+                ram: 153600,
+                security_group_rules: 20,
+                security_groups: 10,
+                server_group_members: 10,
+                server_groups: 10
+            },
+            network: {
+                floatingip: 50,
+                network: 10,
+                port: 160,
+                rbac_policy: 10,
+                router: 10,
+                security_group: 10,
+                security_group_rule: 100,
+                subnet: 10,
+                subnetpool: -1
+            },
+            volume: {
+                backup_gigabytes: 1000,
+                backups: 10,
+                gigabytes: 1000,
+                gigabytes_lvm: -1,
+                per_volume_gigabytes: -1,
+                snapshots: 10,
+                snapshots_lvm: -1,
+                volumes: 10,
+                volumes_lvm: -1
+            }
         }
-    }
 
 '''
 

lib/ansible/modules/cloud/openstack/os_recordset.py

@@ -103,7 +103,7 @@ RETURN = '''
 recordset:
     description: Dictionary describing the recordset.
     returned: On success when I(state) is 'present'.
-    type: dictionary
+    type: complex
     contains:
         id:
             description: Unique recordset ID

lib/ansible/modules/cloud/openstack/os_router.py

@@ -133,7 +133,7 @@ RETURN = '''
 router:
     description: Dictionary describing the router.
     returned: On success when I(state) is 'present'
-    type: dictionary
+    type: complex
     contains:
         id:
             description: Router ID.

lib/ansible/modules/cloud/openstack/os_security_group_rule.py

@@ -136,35 +136,43 @@ RETURN = '''
 id:
   description: Unique rule UUID.
   type: string
+  returned: state == present
 direction:
   description: The direction in which the security group rule is applied.
   type: string
   sample: 'egress'
+  returned: state == present
 ethertype:
   description: One of IPv4 or IPv6.
   type: string
   sample: 'IPv4'
+  returned: state == present
 port_range_min:
   description: The minimum port number in the range that is matched by
                the security group rule.
   type: int
   sample: 8000
+  returned: state == present
 port_range_max:
   description: The maximum port number in the range that is matched by
                the security group rule.
   type: int
   sample: 8000
+  returned: state == present
 protocol:
   description: The protocol that is matched by the security group rule.
   type: string
   sample: 'tcp'
+  returned: state == present
 remote_ip_prefix:
   description: The remote IP prefix to be associated with this security group rule.
   type: string
   sample: '0.0.0.0/0'
+  returned: state == present
 security_group_id:
   description: The security group ID to associate with this security group rule.
   type: string
+  returned: state == present
 '''
 
 try:

lib/ansible/modules/cloud/openstack/os_server_group.py

@@ -93,11 +93,11 @@ name:
 policies:
     description: A list of one or more policy names of the server group.
     returned: success
-    type: list of strings
+    type: list
 members:
     description: A list of members in the server group.
     returned: success
-    type: list of strings
+    type: list
 metadata:
     description: Metadata key and value pairs.
     returned: success

lib/ansible/modules/cloud/openstack/os_stack.py

@@ -104,54 +104,59 @@ id:
     description: Stack ID.
     type: string
     sample: "97a3f543-8136-4570-920e-fd7605c989d6"
+    returned: always
 
 stack:
-    action:
-        description: Action, could be Create or Update.
-        type: string
-        sample: "CREATE"
-    creation_time:
-        description: Time when the action has been made.
-        type: string
-        sample: "2016-07-05T17:38:12Z"
-    description:
-        description: Description of the Stack provided in the heat template.
-        type: string
-        sample: "HOT template to create a new instance and networks"
-    id:
-        description: Stack ID.
-        type: string
-        sample: "97a3f543-8136-4570-920e-fd7605c989d6"
-    name:
-        description: Name of the Stack
-        type: string
-        sample: "test-stack"
-    identifier:
-        description: Identifier of the current Stack action.
-        type: string
-        sample: "test-stack/97a3f543-8136-4570-920e-fd7605c989d6"
-    links:
-        description: Links to the current Stack.
-        type: list of dict
-        sample: "[{'href': 'http://foo:8004/v1/7f6a/stacks/test-stack/97a3f543-8136-4570-920e-fd7605c989d6']"
-    outputs:
-        description: Output returned by the Stack.
-        type: list of dict
-        sample: "{'description': 'IP address of server1 in private network',
-                    'output_key': 'server1_private_ip',
-                    'output_value': '10.1.10.103'}"
-    parameters:
-        description: Parameters of the current Stack
-        type: dict
-        sample: "{'OS::project_id': '7f6a3a3e01164a4eb4eecb2ab7742101',
-                    'OS::stack_id': '97a3f543-8136-4570-920e-fd7605c989d6',
-                    'OS::stack_name': 'test-stack',
-                    'stack_status': 'CREATE_COMPLETE',
-                    'stack_status_reason': 'Stack CREATE completed successfully',
-                    'status': 'COMPLETE',
-                    'template_description': 'HOT template to create a new instance and networks',
-                    'timeout_mins': 60,
-                    'updated_time': null}"
+    description: stack info
+    type: complex
+    returned: always
+    contains:
+        action:
+            description: Action, could be Create or Update.
+            type: string
+            sample: "CREATE"
+        creation_time:
+            description: Time when the action has been made.
+            type: string
+            sample: "2016-07-05T17:38:12Z"
+        description:
+            description: Description of the Stack provided in the heat template.
+            type: string
+            sample: "HOT template to create a new instance and networks"
+        id:
+            description: Stack ID.
+            type: string
+            sample: "97a3f543-8136-4570-920e-fd7605c989d6"
+        name:
+            description: Name of the Stack
+            type: string
+            sample: "test-stack"
+        identifier:
+            description: Identifier of the current Stack action.
+            type: string
+            sample: "test-stack/97a3f543-8136-4570-920e-fd7605c989d6"
+        links:
+            description: Links to the current Stack.
+            type: list of dict
+            sample: "[{'href': 'http://foo:8004/v1/7f6a/stacks/test-stack/97a3f543-8136-4570-920e-fd7605c989d6']"
+        outputs:
+            description: Output returned by the Stack.
+            type: list of dict
+            sample: "{'description': 'IP address of server1 in private network',
+                        'output_key': 'server1_private_ip',
+                        'output_value': '10.1.10.103'}"
+        parameters:
+            description: Parameters of the current Stack
+            type: dict
+            sample: "{'OS::project_id': '7f6a3a3e01164a4eb4eecb2ab7742101',
+                        'OS::stack_id': '97a3f543-8136-4570-920e-fd7605c989d6',
+                        'OS::stack_name': 'test-stack',
+                        'stack_status': 'CREATE_COMPLETE',
+                        'stack_status_reason': 'Stack CREATE completed successfully',
+                        'status': 'COMPLETE',
+                        'template_description': 'HOT template to create a new instance and networks',
+                        'timeout_mins': 60,
+                        'updated_time': null}"
 '''
 
 from time import sleep

lib/ansible/modules/cloud/openstack/os_user.py

@@ -118,7 +118,7 @@ RETURN = '''
 user:
     description: Dictionary describing the user.
     returned: On success when I(state) is 'present'
-    type: dictionary
+    type: complex
     contains:
         default_project_id:
             description: User default project ID. Only present with Keystone >= v3.

lib/ansible/modules/cloud/openstack/os_zone.py

@@ -102,7 +102,7 @@ RETURN = '''
 zone:
     description: Dictionary describing the zone.
     returned: On success when I(state) is 'present'.
-    type: dictionary
+    type: complex
     contains:
         id:
             description: Unique zone ID