plugins/modules/ali_rds_instance

#!/usr/bin/python # Copyright (c) 2017-present Alibaba Group Holding Limited. <xiaozhu36> # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) from __future__ import (absolute_import, division, print_function) __metaclass__ = type ANSIBLE_METADATA = {'metadata_version': '1.1', 'status': ['preview'], 'supported_by': 'community'} DOCUMENTATION = ''' --- module: ali_rds_instance_info short_description: Gather info on rds instance in Alibaba Cloud. description: - Gather info on rds instance in Alibaba Cloud and Support use tags, name_prefix to filter rds. options: name_prefix: description: - Use instance name prefix to filter rds. type: str db_instance_ids: description: - Use instance ids to filter rds. type: list elements: str tags: description: - A hash/dictionaries of rds tags. C({"key":"value"}). type: dict author: - "He Guimin (@xiaozhu36)" requirements: - "python >= 3.6" - "footmark >= 1.16.0" extends_documentation_fragment: - alibaba.alicloud.alicloud ''' EXAMPLES = ''' - name: Get the existing rds with name prefix alibaba.alicloud.ali_rds_instance_info: name_prefix: ansible_rds - name: Retrieving all rds alibaba.alicloud.ali_rds_instance_info: ''' RETURN = ''' instances: description: Describe the info after operating rds instance. returned: always type: complex contains: db_instance_class: description: The type of the instance. returned: always type: str sample: rds.mysql.t1.small db_instance_description: description: The description of the instance. returned: always type: str sample: ansible_test_rds db_instance_id: description: The ID of the instance. returned: always type: str sample: rm-uf6wjk5xxxxxxxxxx db_instance_net_type: description: The network type of the instance. returned: always type: str sample: Internet db_instance_status: description: The status of the instance. returned: always type: str sample: Running db_instance_type: description: The type of the instance role. returned: always type: str sample: Primary engine: description: The type of the database. returned: always type: str sample: MySQL engine_version: description: The version of the database. returned: always type: str sample: 5.6 id: description: alias of 'db_instance_id'. returned: always type: str sample: rm-uf6wjk5xxxxxxxxxx type: description: alias of 'db_instance_type'. returned: always type: str sample: Primary instance_network_type: description: The network type of the instance. returned: always type: str sample: VPC name: description: alias of 'db_instance_description'. returned: always type: string sample: ansible_test_rds pay_type: description: The billing method of the instance. returned: always type: str sample: Postpaid resource_group_id: description: The ID of the resource group. returned: always type: str sample: rg-acfmyxxxxxxx status: description: alias of 'db_instance_status' returned: always type: str sample: Running vpc_cloud_instance_id: description: The ID of the VPC instance returned: always type: str sample: rm-uf6wjk5xxxxxxx vpc_id: description: The ID of the VPC. returned: always type: str sample: vpc-uf6f7l4fg90xxxxxxx vswitch_id: description: The ID of the VSwitch. returned: always type: str sample: vsw-uf6adz52c2pxxxxxxx lock_mode: description: The lock mode of the instance. returned: always type: str sample: Unlock connection_mode: description: The access mode of the instance. returned: always type: str sample: Standard account_max_quantity: description: The maximum number of accounts that can be created in an instance. returned: always type: int sample: 50 account_type: description: The type of the account. returned: always type: str sample: Mix auto_upgrade_minor_version: description: The method of upgrading an instance to a minor version. returned: always type: str sample: Auto availability_value: description: The availability of the instance. returned: always type: str sample: 100.0% category: description: The edition (series) of the instance. returned: always type: str sample: Basic connection_string: description: The private IP address of the instance. returned: always type: str sample: rm-uf6wjk5xxxxxxxxxx.mysql.rds.aliyuncs.com creation_time: description: The time when the instance is created returned: always type: str sample: '2011-05-30T12:11:04Z' current_kernel_version: description: The current kernel version. returned: always type: str sample: rds_20181010 db_instance_class_type: description: The instance type (specifications). returned: always type: str sample: rds.mys2.small db_instance_cpu: description: The count of the instance cpu. returned: always type: int sample: 2 db_instance_memory: description: The memory of the instance. returned: always type: int sample: 4096 db_instance_storage: description: The type of the instance. returned: always type: str sample: rds.mysql.t1.small db_instance_storage_type: description: The storage capacity of the instance. returned: always type: int sample: 10 db_max_quantity: description: The maximum number of databases that can be created in an instance. returned: always type: int sample: 200 dispense_mode: description: The allocation mode. returned: always type: str sample: ClassicDispenseMode expire_time: description: The expiration time. returned: always type: str sample: '2019-03-27T16:00:00Z' maintain_time: description: The maintenance period of the instance. returned: always type: str sample: '00:00Z-02:00Z' max_connections: description: The maximum number of concurrent connections. returned: always type: int sample: 60 max_iops: description: The maximum number of I/O requests per second. returned: always type: int sample: 60 origin_configuration: description: The type of the instance. returned: always type: str sample: rds.mysql.t1.small port: description: The private port of the instance. returned: always type: str sample: 3306 read_only_dbinstance_ids: description: The IDs of read-only instances attached to the master instance. returned: always type: complex contains: read_only_dbinstance_id: description: The ID of a read-only instance. returned: always type: list sample: ['rr-bpxxxxxxxxx'] security_ipmode: description: The IP whitelist mode. returned: always type: complex sample: normal ''' from ansible.module_utils.basic import AnsibleModule from ansible_collections.alibaba.alicloud.plugins.module_utils.alicloud_ecs import ecs_argument_spec, rds_connect HAS_FOOTMARK = False try: from footmark.exception import RDSResponseError HAS_FOOTMARK = True except ImportError: HAS_FOOTMARK = False def main(): argument_spec = ecs_argument_spec() argument_spec.update(dict( name_prefix=dict(type='str'), db_instance_ids=dict(type='list', elements='str'), tags=dict(type='dict') )) module = AnsibleModule(argument_spec=argument_spec) rds = rds_connect(module) name_prefix = module.params['name_prefix'] db_instance_ids = module.params['db_instance_ids'] if HAS_FOOTMARK is False: module.fail_json(msg="Package 'footmark' required for this module.") result = [] try: for rds_instance in rds.describe_db_instances(**module.params): if name_prefix and not rds_instance.read()['name'].startswith(name_prefix): continue if db_instance_ids and rds_instance.read()['id'] not in db_instance_ids: continue result.append(rds_instance.get().read()) module.exit_json(changed=False, instances=result) except Exception as e: module.fail_json(msg="Unable to describe rds db instance, and got an error: {0}.".format(e)) if __name__ == '__main__': main()

plugins/modules/ali_rds_instance_info.py (302 lines of code) (raw):