mirror of
https://opendev.org/openstack/ansible-collections-openstack.git
synced 2026-04-07 22:33:04 +00:00
e4be201f20
With "extends_documentation_fragment: ['openstack.cloud.openstack']" it is not necessary to list required Python libraries in section 'requirements' of DOCUMENTATION docstring in modules. Ansible will merge requirements from doc fragments and DOCUMENTATION docstring which previously resulted in duplicates such as in server module [0]: * openstacksdk * openstacksdk >= 0.36, < 0.99.0 * python >= 3.6 When removing the 'requirements' section from server module, then Ansible will list openstacksdk once only: * openstacksdk >= 0.36, < 0.99.0 * python >= 3.6 To see what documentation Ansible will produce for server module run: ansible-doc --type module openstack.cloud.server [0] https://docs.ansible.com/ansible/latest/collections/openstack/\ cloud/server_module.html Change-Id: Ia53c2c34436c7a72080602f5699e82d20f677b8b
126 lines
2.9 KiB
Python
126 lines
2.9 KiB
Python
#!/usr/bin/python
|
|
# coding: utf-8 -*-
|
|
#
|
|
# Copyright (c) 2020 by Open Telekom Cloud, operated by T-Systems International GmbH
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
|
|
DOCUMENTATION = '''
|
|
---
|
|
module: volume_backup_info
|
|
short_description: Get Backups
|
|
author: OpenStack Ansible SIG
|
|
description:
|
|
- Get Backup info from the Openstack cloud.
|
|
options:
|
|
name:
|
|
description:
|
|
- Name of the Backup.
|
|
type: str
|
|
volume:
|
|
description:
|
|
- Name of the volume.
|
|
type: str
|
|
extends_documentation_fragment:
|
|
- openstack.cloud.openstack
|
|
'''
|
|
|
|
RETURN = '''
|
|
volume_backups:
|
|
description: List of dictionaries describing volume backups.
|
|
type: list
|
|
elements: dict
|
|
returned: always.
|
|
contains:
|
|
availability_zone:
|
|
description: Backup availability zone.
|
|
type: str
|
|
created_at:
|
|
description: Backup creation time.
|
|
type: str
|
|
description:
|
|
description: Backup desciption.
|
|
type: str
|
|
id:
|
|
description: Unique UUID.
|
|
type: str
|
|
sample: "39007a7e-ee4f-4d13-8283-b4da2e037c69"
|
|
is_incremental:
|
|
description: Backup incremental property.
|
|
type: bool
|
|
metadata:
|
|
description: Backup metadata.
|
|
type: dict
|
|
name:
|
|
description: Backup Name.
|
|
type: str
|
|
snapshot_id:
|
|
description: Snapshot ID.
|
|
type: str
|
|
status:
|
|
description: Backup status.
|
|
type: str
|
|
updated_at:
|
|
description: Backup update time.
|
|
type: str
|
|
volume_id:
|
|
description: Volume ID.
|
|
type: str
|
|
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
# Get backups.
|
|
- openstack.cloud.volume_backup_info:
|
|
register: backup
|
|
|
|
- openstack.cloud.volume_backup_info:
|
|
name: my_fake_backup
|
|
register: backup
|
|
'''
|
|
|
|
from ansible_collections.openstack.cloud.plugins.module_utils.openstack import OpenStackModule
|
|
|
|
|
|
class VolumeBackupInfoModule(OpenStackModule):
|
|
module_min_sdk_version = '0.49.0'
|
|
|
|
argument_spec = dict(
|
|
name=dict(required=False, type='str'),
|
|
volume=dict(required=False, type='str')
|
|
)
|
|
module_kwargs = dict(
|
|
supports_check_mode=True
|
|
)
|
|
|
|
def run(self):
|
|
name_filter = self.params['name']
|
|
volume = self.params['volume']
|
|
|
|
data = []
|
|
attrs = {}
|
|
|
|
if name_filter:
|
|
attrs['name'] = name_filter
|
|
if volume:
|
|
attrs['volume_id'] = self.conn.block_storage.find_volume(volume)
|
|
|
|
for raw in self.conn.block_storage.backups(**attrs):
|
|
dt = raw.to_dict()
|
|
dt.pop('location')
|
|
data.append(dt)
|
|
|
|
self.exit_json(
|
|
changed=False,
|
|
volume_backups=data
|
|
)
|
|
|
|
|
|
def main():
|
|
module = VolumeBackupInfoModule()
|
|
module()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|