From a1484a0e5b2e1c3a21eeb22fca9320cb53677e47 Mon Sep 17 00:00:00 2001 From: Brian Coca Date: Fri, 9 Oct 2015 18:36:58 -0400 Subject: [PATCH] doc fixes --- .../modules/cloud/openstack/os_image_facts.py | 145 +++++++++--------- .../cloud/openstack/os_networks_facts.py | 56 +++---- .../modules/cloud/openstack/os_server.py | 4 +- 3 files changed, 104 insertions(+), 101 deletions(-) diff --git a/lib/ansible/modules/cloud/openstack/os_image_facts.py b/lib/ansible/modules/cloud/openstack/os_image_facts.py index fa5678b50b7..a54537172eb 100644 --- a/lib/ansible/modules/cloud/openstack/os_image_facts.py +++ b/lib/ansible/modules/cloud/openstack/os_image_facts.py @@ -22,7 +22,6 @@ except ImportError: HAS_SHADE = False DOCUMENTATION = ''' ---- module: os_image_facts short_description: Retrieve facts about an image within OpenStack. version_added: "2.0" @@ -55,77 +54,79 @@ EXAMPLES = ''' ''' RETURN = ''' -This module registers image details in facts named: openstack_image. When -image is not found, openstack_image will be null. - -id: - description: Unique UUID. - returned: success - type: string -name: - description: Name given to the image. - returned: success - type: string -status: - description: Image status. - returned: success - type: string -created_at: - description: Image created at timestamp. - returned: success - type: string -deleted: - description: Image deleted flag. - returned: success - type: boolean -container_format: - description: Container format of the image. - returned: success - type: string -min_ram: - description: Min amount of RAM required for this image. - returned: success - type: int -disk_format: - description: Disk format of the image. - returned: success - type: string -updated_at: - description: Image updated at timestamp. - returned: success - type: string -properties: - description: Additional properties associated with the image. - returned: success - type: dict -min_disk: - description: Min amount of disk space required for this image. - returned: success - type: int -protected: - description: Image protected flag. - returned: success - type: boolean -checksum: - description: Checksum for the image. - returned: success - type: string -owner: - description: Owner for the image. - returned: success - type: string -is_public: - description: Is plubic flag of the image. - returned: success - type: boolean -deleted_at: - description: Image deleted at timestamp. - returned: success - type: string -size: - description: Size of the image. - returned: success - type: int +openstack_image: + description: has all the openstack facts about the image + returned: always, but can be null + type: complex + contains: + id: + description: Unique UUID. + returned: success + type: string + name: + description: Name given to the image. + returned: success + type: string + status: + description: Image status. + returned: success + type: string + created_at: + description: Image created at timestamp. + returned: success + type: string + deleted: + description: Image deleted flag. + returned: success + type: boolean + container_format: + description: Container format of the image. + returned: success + type: string + min_ram: + description: Min amount of RAM required for this image. + returned: success + type: int + disk_format: + description: Disk format of the image. + returned: success + type: string + updated_at: + description: Image updated at timestamp. + returned: success + type: string + properties: + description: Additional properties associated with the image. + returned: success + type: dict + min_disk: + description: Min amount of disk space required for this image. + returned: success + type: int + protected: + description: Image protected flag. + returned: success + type: boolean + checksum: + description: Checksum for the image. + returned: success + type: string + owner: + description: Owner for the image. + returned: success + type: string + is_public: + description: Is plubic flag of the image. + returned: success + type: boolean + deleted_at: + description: Image deleted at timestamp. + returned: success + type: string + size: + description: Size of the image. + returned: success + type: int ''' diff --git a/lib/ansible/modules/cloud/openstack/os_networks_facts.py b/lib/ansible/modules/cloud/openstack/os_networks_facts.py index 56c30adb203..6ac8786463d 100644 --- a/lib/ansible/modules/cloud/openstack/os_networks_facts.py +++ b/lib/ansible/modules/cloud/openstack/os_networks_facts.py @@ -82,33 +82,35 @@ EXAMPLES = ''' ''' RETURN = ''' -This module registers network details in facts named: openstack_networks. If a -network name/id and or filter does not result in a network found, an empty -list is set in openstack_networks. -id: - description: Unique UUID. - returned: success - type: string -name: - description: Name given to the network. - returned: success - type: string -status: - description: Network status. - returned: success - type: string -subnets: - description: Subnet(s) included in this network. - returned: success - type: list of strings -tenant_id: - description: Tenant id associated with this network. - returned: success - type: string -shared: - description: Network shared flag. - returned: success - type: boolean +openstack_networks: + description: has all the openstack facts about the networks + returned: always, but can be null + type: complex + contains: + id: + description: Unique UUID. + returned: success + type: string + name: + description: Name given to the network. + returned: success + type: string + status: + description: Network status. + returned: success + type: string + subnets: + description: Subnet(s) included in this network. + returned: success + type: list of strings + tenant_id: + description: Tenant id associated with this network. + returned: success + type: string + shared: + description: Network shared flag. + returned: success + type: boolean ''' def main(): diff --git a/lib/ansible/modules/cloud/openstack/os_server.py b/lib/ansible/modules/cloud/openstack/os_server.py index 0cc4741903a..d9d23042d68 100644 --- a/lib/ansible/modules/cloud/openstack/os_server.py +++ b/lib/ansible/modules/cloud/openstack/os_server.py @@ -86,8 +86,8 @@ options: - A list of networks to which the instance's interface should be attached. Networks may be referenced by net-id/net-name/port-id or port-name. - Also this accepts a string containing a list of net-id/port-id. - Eg: nics: "net-id=uuid-1,net-id=uuid-2" + - 'Also this accepts a string containing a list of net-id/port-id. + Eg: nics: "net-id=uuid-1,net-id=uuid-2"' required: false default: None public_ip: