cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

doc fixes

Browse source
This commit is contained in:
Brian Coca 2015-10-09 18:36:58 -04:00 committed by Matt Clay
parent 5872e0a493
commit a1484a0e5b
3 changed files with 104 additions and 101 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

145
lib/ansible/modules/cloud/openstack/os_image_facts.py
View file

@ -22,7 +22,6 @@ except ImportError:
HAS_SHADE = False HAS_SHADE = False
DOCUMENTATION = ''' DOCUMENTATION = '''
---
module: os_image_facts module: os_image_facts
short_description: Retrieve facts about an image within OpenStack. short_description: Retrieve facts about an image within OpenStack.
version_added: "2.0" version_added: "2.0"
@ -55,77 +54,79 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
This module registers image details in facts named: openstack_image. When openstack_image:
image is not found, openstack_image will be null. description: has all the openstack facts about the image
returned: always, but can be null
id: type: complex
description: Unique UUID. contains:
returned: success id:
type: string description: Unique UUID.
name: returned: success
description: Name given to the image. type: string
returned: success name:
type: string description: Name given to the image.
status: returned: success
description: Image status. type: string
returned: success status:
type: string description: Image status.
created_at: returned: success
description: Image created at timestamp. type: string
returned: success created_at:
type: string description: Image created at timestamp.
deleted: returned: success
description: Image deleted flag. type: string
returned: success deleted:
type: boolean description: Image deleted flag.
container_format: returned: success
description: Container format of the image. type: boolean
returned: success container_format:
type: string description: Container format of the image.
min_ram: returned: success
description: Min amount of RAM required for this image. type: string
returned: success min_ram:
type: int description: Min amount of RAM required for this image.
disk_format: returned: success
description: Disk format of the image. type: int
returned: success disk_format:
type: string description: Disk format of the image.
updated_at: returned: success
description: Image updated at timestamp. type: string
returned: success updated_at:
type: string description: Image updated at timestamp.
properties: returned: success
description: Additional properties associated with the image. type: string
returned: success properties:
type: dict description: Additional properties associated with the image.
min_disk: returned: success
description: Min amount of disk space required for this image. type: dict
returned: success min_disk:
type: int description: Min amount of disk space required for this image.
protected: returned: success
description: Image protected flag. type: int
returned: success protected:
type: boolean description: Image protected flag.
checksum: returned: success
description: Checksum for the image. type: boolean
returned: success checksum:
type: string description: Checksum for the image.
owner: returned: success
description: Owner for the image. type: string
returned: success owner:
type: string description: Owner for the image.
is_public: returned: success
description: Is plubic flag of the image. type: string
returned: success is_public:
type: boolean description: Is plubic flag of the image.
deleted_at: returned: success
description: Image deleted at timestamp. type: boolean
returned: success deleted_at:
type: string description: Image deleted at timestamp.
size: returned: success
description: Size of the image. type: string
returned: success size:
type: int description: Size of the image.
returned: success
type: int
''' '''

56
lib/ansible/modules/cloud/openstack/os_networks_facts.py
View file

@ -82,33 +82,35 @@ EXAMPLES = '''
''' '''
RETURN = ''' RETURN = '''
This module registers network details in facts named: openstack_networks. If a openstack_networks:
network name/id and or filter does not result in a network found, an empty description: has all the openstack facts about the networks
list is set in openstack_networks. returned: always, but can be null
id: type: complex
description: Unique UUID. contains:
returned: success id:
type: string description: Unique UUID.
name: returned: success
description: Name given to the network. type: string
returned: success name:
type: string description: Name given to the network.
status: returned: success
description: Network status. type: string
returned: success status:
type: string description: Network status.
subnets: returned: success
description: Subnet(s) included in this network. type: string
returned: success subnets:
type: list of strings description: Subnet(s) included in this network.
tenant_id: returned: success
description: Tenant id associated with this network. type: list of strings
returned: success tenant_id:
type: string description: Tenant id associated with this network.
shared: returned: success
description: Network shared flag. type: string
returned: success shared:
type: boolean description: Network shared flag.
returned: success
type: boolean
''' '''
def main(): def main():

4
lib/ansible/modules/cloud/openstack/os_server.py
View file

@ -86,8 +86,8 @@ options:
- A list of networks to which the instance's interface should - A list of networks to which the instance's interface should
be attached. Networks may be referenced by net-id/net-name/port-id be attached. Networks may be referenced by net-id/net-name/port-id
or port-name. or port-name.
Also this accepts a string containing a list of net-id/port-id. - 'Also this accepts a string containing a list of net-id/port-id.
Eg: nics: "net-id=uuid-1,net-id=uuid-2" Eg: nics: "net-id=uuid-1,net-id=uuid-2"'
required: false required: false
default: None default: None
public_ip: public_ip: