Adding new image facts module
This commit is contained in:
dagnello
Matt Clay
parent
d76f6cceed
commit
d46894cf91
1 changed files with 157 additions and 0 deletions
157
lib/ansible/modules/cloud/openstack/os_image_facts.py
Normal file
157
lib/ansible/modules/cloud/openstack/os_image_facts.py
Normal file
|
|
@ -0,0 +1,157 @@
|
||||||
|
#!/usr/bin/python
|
||||||
|
|
||||||
|
# Copyright (c) 2015 Hewlett-Packard Development Company, L.P.
|
||||||
|
#
|
||||||
|
# This module is free software: you can redistribute it and/or modify
|
||||||
|
# it under the terms of the GNU General Public License as published by
|
||||||
|
# the Free Software Foundation, either version 3 of the License, or
|
||||||
|
# (at your option) any later version.
|
||||||
|
#
|
||||||
|
# This software is distributed in the hope that it will be useful,
|
||||||
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
# GNU General Public License for more details.
|
||||||
|
#
|
||||||
|
# You should have received a copy of the GNU General Public License
|
||||||
|
# along with this software. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
try:
|
||||||
|
import shade
|
||||||
|
HAS_SHADE = True
|
||||||
|
except ImportError:
|
||||||
|
HAS_SHADE = False
|
||||||
|
|
||||||
|
DOCUMENTATION = '''
|
||||||
|
---
|
||||||
|
module: os_image_facts
|
||||||
|
short_description: Retrieve facts about an image within OpenStack.
|
||||||
|
version_added: "2.0"
|
||||||
|
author: "Davide Agnello (@dagnello)"
|
||||||
|
description:
|
||||||
|
- Retrieve facts about a image image from OpenStack.
|
||||||
|
notes:
|
||||||
|
- Facts are placed in the C(openstack) variable.
|
||||||
|
requirements:
|
||||||
|
- "python >= 2.6"
|
||||||
|
- "shade"
|
||||||
|
options:
|
||||||
|
image:
|
||||||
|
description:
|
||||||
|
- Name or ID of the image
|
||||||
|
required: true
|
||||||
|
extends_documentation_fragment: openstack
|
||||||
|
'''
|
||||||
|
|
||||||
|
EXAMPLES = '''
|
||||||
|
# Gather facts about a previously created image named image1
|
||||||
|
- os_image_facts:
|
||||||
|
auth:
|
||||||
|
auth_url: https://your_api_url.com:9000/v2.0
|
||||||
|
username: user
|
||||||
|
password: password
|
||||||
|
project_name: someproject
|
||||||
|
image: image1
|
||||||
|
- debug: var=openstack
|
||||||
|
'''
|
||||||
|
|
||||||
|
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
|
||||||
|
'''
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
|
||||||
|
argument_spec = openstack_full_argument_spec(
|
||||||
|
image=dict(required=True),
|
||||||
|
)
|
||||||
|
module_kwargs = openstack_module_kwargs()
|
||||||
|
module = AnsibleModule(argument_spec, **module_kwargs)
|
||||||
|
|
||||||
|
if not HAS_SHADE:
|
||||||
|
module.fail_json(msg='shade is required for this module')
|
||||||
|
|
||||||
|
try:
|
||||||
|
cloud = shade.openstack_cloud(**module.params)
|
||||||
|
image = cloud.get_image(module.params['image'])
|
||||||
|
module.exit_json(changed=False, ansible_facts=dict(
|
||||||
|
openstack_image=image))
|
||||||
|
|
||||||
|
except shade.OpenStackCloudException as e:
|
||||||
|
module.fail_json(msg=e.message)
|
||||||
|
|
||||||
|
# this is magic, see lib/ansible/module_common.py
|
||||||
|
from ansible.module_utils.basic import *
|
||||||
|
from ansible.module_utils.openstack import *
|
||||||
|
if __name__ == '__main__':
|
||||||
|
main()
|
||||||
|
|
||||||
Loading…
Reference in a new issue