#!/usr/bin/python # # Copyright (c) 2017 Zim Kalinowski, # # 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 DOCUMENTATION = ''' --- module: azure_rm_postgresqlserver version_added: "0.1.2" short_description: Manage PostgreSQL Server instance description: - Create, update and delete instance of PostgreSQL Server. options: resource_group: description: - The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. required: True type: str name: description: - The name of the server. required: True type: str sku: description: - The SKU (pricing tier) of the server. type: dict suboptions: name: description: - The name of the SKU, typically, tier + family + cores, for example C(B_Gen4_1), C(GP_Gen5_8). tier: description: - The tier of the particular SKU, for example C(Basic). choices: - Basic - Standard capacity: description: - The scale up/out capacity, representing server's compute units. size: description: - The size code, to be interpreted by resource as appropriate. location: description: - Resource location. If not set, location from the resource group will be used as default. type: str storage_mb: description: - The maximum storage allowed for a server. type: int geo_redundant_backup: description: - Choose between locally redundant(default) or geo-redundant backup. This cannot be updated after first deployment type: bool default: False backup_retention_days: description: - Backup retention period between 7 and 35 days. 7 days by default if not set type: int version: description: - Server version. type: str choices: - '9.5' - '9.6' - '10' - '11' enforce_ssl: description: - Enable SSL enforcement. type: bool default: False storage_autogrow: description: - Enable storage autogrow. type: bool default: False admin_username: description: - The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). type: str admin_password: description: - The password of the administrator login. - The supplied password must be between 6-72 characters long and must satisfy at least 3 of password complexity requirements from the following. - 1. Contains an uppercase character - 2. Contains a lowercase character - 3. Contains a numeric digit - 4. Contains a special character - 5. Control characters are not allowed type: str create_mode: description: - Create mode of SQL Server. Blank (default), restore from geo redundant (geo_restore), or restore from point in time (point_in_time_restore). type: str default: default choices: - default - geo_restore - point_in_time_restore source_server_id: description: - Id if the source server if I(create_mode=default). type: str restore_point_in_time: description: - Restore point creation time (ISO8601 format), specifying the time to restore from. - Required if I(create_mode=point_in_time_restore). type: str state: description: - Assert the state of the PostgreSQL server. Use C(present) to create or update a server and C(absent) to delete it. default: present type: str choices: - present - absent extends_documentation_fragment: - azure.azcollection.azure - azure.azcollection.azure_tags author: - Zim Kalinowski (@zikalino) ''' EXAMPLES = ''' - name: Create (or update) PostgreSQL Server azure_rm_postgresqlserver: resource_group: myResourceGroup name: testserver sku: name: B_Gen5_1 tier: Basic location: eastus storage_mb: 1024 enforce_ssl: true storage_autogrow: true admin_username: cloudsa admin_password: "{{ password }}" ''' RETURN = ''' id: description: - Resource ID. returned: always type: str sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.DBforPostgreSQL/servers/mysqlsrv1b6dd89593 version: description: - Server version. Possible values include C(9.5), C(9.6), C(10), C(11). returned: always type: str sample: 9.6 state: description: - A state of a server that is visible to user. Possible values include C(Ready), C(Dropping), C(Disabled). returned: always type: str sample: Ready fully_qualified_domain_name: description: - The fully qualified domain name of a server. returned: always type: str sample: postgresqlsrv1b6dd89593.postgresql.database.azure.com ''' import time try: from ansible_collections.azure.azcollection.plugins.module_utils.azure_rm_common import AzureRMModuleBase from azure.core.exceptions import ResourceNotFoundError from azure.core.polling import LROPoller except ImportError: # This is handled in azure_rm_common pass class Actions: NoAction, Create, Update, Delete = range(4) class AzureRMPostgreSqlServers(AzureRMModuleBase): """Configuration class for an Azure RM PostgreSQL Server resource""" def __init__(self): self.module_arg_spec = dict( resource_group=dict( type='str', required=True ), name=dict( type='str', required=True ), sku=dict( type='dict' ), location=dict( type='str' ), storage_mb=dict( type='int' ), geo_redundant_backup=dict( type='bool', default=False ), backup_retention_days=dict( type='int', ), version=dict( type='str', choices=['9.5', '9.6', '10', '11'] ), enforce_ssl=dict( type='bool', default=False ), storage_autogrow=dict( type='bool', default=False ), create_mode=dict( type='str', default='default', choices=['default', 'geo_restore', 'point_in_time_restore'] ), source_server_id=dict( type='str' ), restore_point_in_time=dict( type='str' ), admin_username=dict( type='str' ), admin_password=dict( type='str', no_log=True ), state=dict( type='str', default='present', choices=['present', 'absent'] ) ) self.resource_group = None self.name = None self.parameters = {'properties': {'create_mode': 'default'}} self.tags = None self.results = dict(changed=False) self.state = None self.to_do = Actions.NoAction super(AzureRMPostgreSqlServers, self).__init__(derived_arg_spec=self.module_arg_spec, supports_check_mode=True, supports_tags=True) def exec_module(self, **kwargs): """Main module execution method""" for key in list(self.module_arg_spec.keys()) + ['tags']: if hasattr(self, key): setattr(self, key, kwargs[key]) elif kwargs[key] is not None: if key == "sku": ev = kwargs[key] if 'tier' in ev: if ev['tier'] == 'basic': ev['tier'] = 'Basic' elif ev['tier'] == 'standard': ev['tier'] = 'Standard' self.parameters["sku"] = ev elif key == "location": self.parameters["location"] = kwargs[key] elif key == "storage_mb": self.parameters.setdefault("properties", {}).setdefault("storage_profile", {})["storage_mb"] = \ kwargs[key] elif key == "storage_autogrow": self.parameters.setdefault("properties", {}).setdefault("storage_profile", {})[ "storage_autogrow"] = ('Enabled' if kwargs[key] else 'Disabled') elif key == "geo_redundant_backup": self.parameters.setdefault("properties", {}).setdefault("storage_profile", {})[ "geo_redundant_backup"] = \ 'Enabled' if kwargs[key] else 'Disabled' elif key == "backup_retention_days": self.parameters.setdefault("properties", {}).setdefault("storage_profile", {})[ "backup_retention_days"] = kwargs[key] elif key == "version": self.parameters.setdefault("properties", {})["version"] = kwargs[key] elif key == "enforce_ssl": self.parameters.setdefault("properties", {})["ssl_enforcement"] = 'Enabled' if kwargs[ key] else 'Disabled' elif key == "create_mode": if kwargs[key] == 'default': self.parameters["properties"]["create_mode"] = 'Default' elif kwargs[key] == 'point_in_time_restore': self.parameters["properties"]["create_mode"] = 'PointInTimeRestore' elif kwargs[key] == 'geo_restore': self.parameters["properties"]["create_mode"] = 'GeoRestore' elif key == "admin_username": self.parameters.setdefault("properties", {})["administrator_login"] = kwargs[key] elif key == "admin_password": self.parameters.setdefault("properties", {})["administrator_login_password"] = kwargs[key] elif key == "source_server_id": self.parameters["properties"]["source_server_id"] = kwargs[key] elif key == "restore_point_in_time": self.parameters["properties"]["restore_point_in_time"] = kwargs[key] old_response = None response = None resource_group = self.get_resource_group(self.resource_group) if "location" not in self.parameters: self.parameters["location"] = resource_group.location old_response = self.get_postgresqlserver() if not old_response: self.log("PostgreSQL Server instance doesn't exist") if self.state == 'absent': self.log("Old instance didn't exist") else: self.to_do = Actions.Create else: self.log("PostgreSQL Server instance already exists") if self.state == 'absent': self.to_do = Actions.Delete elif self.state == 'present': self.log("Need to check if PostgreSQL Server instance has to be deleted or may be updated") update_tags, newtags = self.update_tags(old_response.get('tags', {})) if update_tags: self.tags = newtags self.to_do = Actions.Update if (self.to_do == Actions.Create) or (self.to_do == Actions.Update): self.log("Need to Create / Update the PostgreSQL Server instance") if self.check_mode: self.results['changed'] = True return self.results response = self.create_update_postgresqlserver() if not old_response: self.results['changed'] = True else: self.results['changed'] = old_response.__ne__(response) self.log("Creation / Update done") elif self.to_do == Actions.Delete: self.log("PostgreSQL Server instance deleted") self.results['changed'] = True if self.check_mode: return self.results self.delete_postgresqlserver() # make sure instance is actually deleted, for some Azure resources, instance is hanging around # for some time after deletion -- this should be really fixed in Azure while self.get_postgresqlserver(): time.sleep(20) else: self.log("PostgreSQL Server instance unchanged") self.results['changed'] = False response = old_response if response: self.results["id"] = response["id"] self.results["version"] = response["version"] self.results["state"] = response["user_visible_state"] self.results["fully_qualified_domain_name"] = response["fully_qualified_domain_name"] return self.results def create_update_postgresqlserver(self): ''' Creates or updates PostgreSQL Server with the specified configuration. :return: deserialized PostgreSQL Server instance state dictionary ''' self.log("Creating / Updating the PostgreSQL Server instance {0}".format(self.name)) try: self.parameters['tags'] = self.tags if self.to_do == Actions.Create: response = self.postgresql_client.servers.begin_create(resource_group_name=self.resource_group, server_name=self.name, parameters=self.parameters) else: # structure of parameters for update must be changed self.parameters.update(self.parameters.pop("properties", {})) response = self.postgresql_client.servers.begin_update(resource_group_name=self.resource_group, server_name=self.name, parameters=self.parameters) if isinstance(response, LROPoller): response = self.get_poller_result(response) except Exception as exc: self.log('Error attempting to create the PostgreSQL Server instance.') self.fail("Error creating the PostgreSQL Server instance: {0}".format(str(exc))) return response.as_dict() def delete_postgresqlserver(self): ''' Deletes specified PostgreSQL Server instance in the specified subscription and resource group. :return: True ''' self.log("Deleting the PostgreSQL Server instance {0}".format(self.name)) try: response = self.postgresql_client.servers.begin_delete(resource_group_name=self.resource_group, server_name=self.name) except Exception as e: self.log('Error attempting to delete the PostgreSQL Server instance.') self.fail("Error deleting the PostgreSQL Server instance: {0}".format(str(e))) return True def get_postgresqlserver(self): ''' Gets the properties of the specified PostgreSQL Server. :return: deserialized PostgreSQL Server instance state dictionary ''' self.log("Checking if the PostgreSQL Server instance {0} is present".format(self.name)) found = False try: response = self.postgresql_client.servers.get(resource_group_name=self.resource_group, server_name=self.name) found = True self.log("Response : {0}".format(response)) self.log("PostgreSQL Server instance : {0} found".format(response.name)) except ResourceNotFoundError as e: self.log('Did not find the PostgreSQL Server instance.') if found is True: return response.as_dict() return False def main(): """Main execution""" AzureRMPostgreSqlServers() if __name__ == '__main__': main()