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
parent 0307e3e649
commit f707a711cd
3 changed files with 104 additions and 101 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
cloud/openstack/os_image_facts.py
View file

@ -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,74 +54,76 @@ EXAMPLES = '''
'''
RETURN = '''
This module registers image details in facts named: openstack_image. When
image is not found, openstack_image will be null.
id:
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:
name:
description: Name given to the image.
returned: success
type: string
status:
status:
description: Image status.
returned: success
type: string
created_at:
created_at:
description: Image created at timestamp.
returned: success
type: string
deleted:
deleted:
description: Image deleted flag.
returned: success
type: boolean
container_format:
container_format:
description: Container format of the image.
returned: success
type: string
min_ram:
min_ram:
description: Min amount of RAM required for this image.
returned: success
type: int
disk_format:
disk_format:
description: Disk format of the image.
returned: success
type: string
updated_at:
updated_at:
description: Image updated at timestamp.
returned: success
type: string
properties:
properties:
description: Additional properties associated with the image.
returned: success
type: dict
min_disk:
min_disk:
description: Min amount of disk space required for this image.
returned: success
type: int
protected:
protected:
description: Image protected flag.
returned: success
type: boolean
checksum:
checksum:
description: Checksum for the image.
returned: success
type: string
owner:
owner:
description: Owner for the image.
returned: success
type: string
is_public:
is_public:
description: Is plubic flag of the image.
returned: success
type: boolean
deleted_at:
deleted_at:
description: Image deleted at timestamp.
returned: success
type: string
size:
size:
description: Size of the image.
returned: success
type: int

20
cloud/openstack/os_networks_facts.py
View file

@ -82,30 +82,32 @@ 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:
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:
name:
description: Name given to the network.
returned: success
type: string
status:
status:
description: Network status.
returned: success
type: string
subnets:
subnets:
description: Subnet(s) included in this network.
returned: success
type: list of strings
tenant_id:
tenant_id:
description: Tenant id associated with this network.
returned: success
type: string
shared:
shared:
description: Network shared flag.
returned: success
type: boolean

4
cloud/openstack/os_server.py
View file

@ -84,8 +84,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: