mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
adding postgresql server facts (#43328)
* adding postgresql server facts * updating postgresql server facts, minor changes * changed return dict to list * fixed test * fixed several issues * several updates * fixed naming * list -> complex * try again * fixed mistake * added user_visible_state to the result * added fully_qualified_domain_name * fixed second test * updates * fixed test * updated samples in return value * wait for postgresql server to be actually ready * another approach for test * second server was not created * fixing pr comments * fix sanity * removed forgotten ansible_facts
This commit is contained in:
Zim Kalinowski
Matt Davis
parent
a1febd95b7
commit
a73340ee74
2 changed files with 285 additions and 0 deletions
|
|
@ -0,0 +1,225 @@
|
|||
#!/usr/bin/python
|
||||
#
|
||||
# Copyright (c) 2017 Zim Kalinowski, <zikalino@microsoft.com>
|
||||
#
|
||||
# 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: azure_rm_postgresqlserver_facts
|
||||
version_added: "2.7"
|
||||
short_description: Get Azure PostgreSQL Server facts.
|
||||
description:
|
||||
- Get facts 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
|
||||
name:
|
||||
description:
|
||||
- The name of the server.
|
||||
tags:
|
||||
description:
|
||||
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
|
||||
author:
|
||||
- "Zim Kalinowski (@zikalino)"
|
||||
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Get instance of PostgreSQL Server
|
||||
azure_rm_postgresqlserver_facts:
|
||||
resource_group: resource_group_name
|
||||
name: server_name
|
||||
|
||||
- name: List instances of PostgreSQL Server
|
||||
azure_rm_postgresqlserver_facts:
|
||||
resource_group: resource_group_name
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
servers:
|
||||
description: A list of dictionaries containing facts for PostgreSQL servers.
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
id:
|
||||
description:
|
||||
- Resource ID
|
||||
returned: always
|
||||
type: str
|
||||
sample: /subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/TestGroup/providers/Microsoft.DBforPostgreSQL/servers/postgreabdud1223
|
||||
name:
|
||||
description:
|
||||
- Resource name.
|
||||
returned: always
|
||||
type: str
|
||||
sample: postgreabdud1223
|
||||
location:
|
||||
description:
|
||||
- The location the resource resides in.
|
||||
returned: always
|
||||
type: str
|
||||
sample: eastus
|
||||
sku:
|
||||
description:
|
||||
- The SKU of the server.
|
||||
returned: always
|
||||
type: complex
|
||||
contains:
|
||||
name:
|
||||
description:
|
||||
- The name of the SKU
|
||||
returned: always
|
||||
type: str
|
||||
sample: GP_Gen4_2
|
||||
tier:
|
||||
description:
|
||||
- The tier of the particular SKU
|
||||
returned: always
|
||||
type: str
|
||||
sample: GeneralPurpose
|
||||
capacity:
|
||||
description:
|
||||
- The scale capacity.
|
||||
returned: always
|
||||
type: int
|
||||
sample: 2
|
||||
version:
|
||||
description:
|
||||
- Server version.
|
||||
returned: always
|
||||
type: str
|
||||
sample: "9.6"
|
||||
user_visible_state:
|
||||
description:
|
||||
- A state of a server that is visible to user.
|
||||
returned: always
|
||||
type: str
|
||||
sample: Ready
|
||||
fully_qualified_domain_name:
|
||||
description:
|
||||
- The fully qualified domain name of a server.
|
||||
returned: always
|
||||
type: str
|
||||
sample: postgreabdud1223.postgres.database.azure.com
|
||||
'''
|
||||
|
||||
from ansible.module_utils.azure_rm_common import AzureRMModuleBase
|
||||
|
||||
try:
|
||||
from msrestazure.azure_exceptions import CloudError
|
||||
from msrestazure.azure_operation import AzureOperationPoller
|
||||
from azure.mgmt.rdbms.postgresql import PostgreSQLManagementClient
|
||||
from msrest.serialization import Model
|
||||
except ImportError:
|
||||
# This is handled in azure_rm_common
|
||||
pass
|
||||
|
||||
|
||||
class AzureRMServersFacts(AzureRMModuleBase):
|
||||
def __init__(self):
|
||||
# define user inputs into argument
|
||||
self.module_arg_spec = dict(
|
||||
resource_group=dict(
|
||||
type='str',
|
||||
required=True
|
||||
),
|
||||
name=dict(
|
||||
type='str'
|
||||
),
|
||||
tags=dict(
|
||||
type='list'
|
||||
)
|
||||
)
|
||||
# store the results of the module operation
|
||||
self.results = dict(
|
||||
changed=False
|
||||
)
|
||||
self.resource_group = None
|
||||
self.name = None
|
||||
self.tags = None
|
||||
super(AzureRMServersFacts, self).__init__(self.module_arg_spec, supports_tags=False)
|
||||
|
||||
def exec_module(self, **kwargs):
|
||||
for key in self.module_arg_spec:
|
||||
setattr(self, key, kwargs[key])
|
||||
|
||||
if (self.resource_group is not None and
|
||||
self.name is not None):
|
||||
self.results['servers'] = self.get()
|
||||
elif (self.resource_group is not None):
|
||||
self.results['servers'] = self.list_by_resource_group()
|
||||
return self.results
|
||||
|
||||
def get(self):
|
||||
response = None
|
||||
results = []
|
||||
try:
|
||||
response = self.postgresql_client.servers.get(resource_group_name=self.resource_group,
|
||||
server_name=self.name)
|
||||
self.log("Response : {0}".format(response))
|
||||
except CloudError as e:
|
||||
self.log('Could not get facts for PostgreSQL Server.')
|
||||
|
||||
if response and self.has_tags(response.tags, self.tags):
|
||||
results.append(self.format_item(response))
|
||||
|
||||
return results
|
||||
|
||||
def list_by_resource_group(self):
|
||||
response = None
|
||||
results = []
|
||||
try:
|
||||
response = self.postgresql_client.servers.list_by_resource_group(resource_group_name=self.resource_group)
|
||||
self.log("Response : {0}".format(response))
|
||||
except CloudError as e:
|
||||
self.log('Could not get facts for PostgreSQL Servers.')
|
||||
|
||||
if response is not None:
|
||||
for item in response:
|
||||
if self.has_tags(item.tags, self.tags):
|
||||
results.append(self.format_item(item))
|
||||
|
||||
return results
|
||||
|
||||
def format_item(self, item):
|
||||
d = item.as_dict()
|
||||
d = {
|
||||
'id': d['id'],
|
||||
'resource_group': self.resource_group,
|
||||
'name': d['name'],
|
||||
'sku': d['sku'],
|
||||
'location': d['location'],
|
||||
'storage_mb': d['storage_profile']['storage_mb'],
|
||||
'version': d['version'],
|
||||
'enforce_ssl': (d['ssl_enforcement'] == 'Enabled'),
|
||||
'admin_username': d['administrator_login'],
|
||||
'user_visible_state': d['user_visible_state'],
|
||||
'fully_qualified_domain_name': d['fully_qualified_domain_name']
|
||||
}
|
||||
|
||||
return d
|
||||
|
||||
|
||||
def main():
|
||||
AzureRMServersFacts()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
|
|
@ -60,6 +60,66 @@
|
|||
- output.changed == false
|
||||
- output.state == 'Ready'
|
||||
|
||||
- name: Create second instance of PostgreSQL Server
|
||||
azure_rm_postgresqlserver:
|
||||
resource_group: "{{ resource_group }}"
|
||||
name: postgresqlsrv{{ rpfx }}second
|
||||
sku:
|
||||
name: GP_Gen4_2
|
||||
tier: GeneralPurpose
|
||||
location: westus
|
||||
storage_mb: 51200
|
||||
enforce_ssl: True
|
||||
admin_username: zimxyz
|
||||
admin_password: Testpasswordxyz12!
|
||||
|
||||
- name: Gather facts PostgreSQL Server
|
||||
azure_rm_postgresqlserver_facts:
|
||||
resource_group: "{{ resource_group }}"
|
||||
name: postgresqlsrv{{ rpfx }}
|
||||
register: output
|
||||
|
||||
- name: Assert that facts are returned
|
||||
assert:
|
||||
that:
|
||||
- output.changed == False
|
||||
- output.servers[0]['id'] != None
|
||||
- output.servers[0]['name'] != None
|
||||
- output.servers[0]['location'] != None
|
||||
- output.servers[0]['sku']['name'] != None
|
||||
- output.servers[0]['sku']['tier'] != None
|
||||
- output.servers[0]['sku']['capacity'] != None
|
||||
- output.servers[0]['version'] != None
|
||||
- output.servers[0]['user_visible_state'] != None
|
||||
- output.servers[0]['fully_qualified_domain_name'] != None
|
||||
|
||||
- name: Gather facts PostgreSQL Server
|
||||
azure_rm_postgresqlserver_facts:
|
||||
resource_group: "{{ resource_group }}"
|
||||
register: output
|
||||
- name: Assert that facts are returned
|
||||
assert:
|
||||
that:
|
||||
- output.changed == False
|
||||
- output.servers[0]['id'] != None
|
||||
- output.servers[0]['name'] != None
|
||||
- output.servers[0]['location'] != None
|
||||
- output.servers[0]['sku']['name'] != None
|
||||
- output.servers[0]['sku']['tier'] != None
|
||||
- output.servers[0]['sku']['capacity'] != None
|
||||
- output.servers[0]['version'] != None
|
||||
- output.servers[0]['user_visible_state'] != None
|
||||
- output.servers[0]['fully_qualified_domain_name'] != None
|
||||
- output.servers[1]['id'] != None
|
||||
- output.servers[1]['name'] != None
|
||||
- output.servers[1]['location'] != None
|
||||
- output.servers[1]['sku']['name'] != None
|
||||
- output.servers[1]['sku']['tier'] != None
|
||||
- output.servers[1]['sku']['capacity'] != None
|
||||
- output.servers[1]['version'] != None
|
||||
- output.servers[1]['user_visible_state'] != None
|
||||
- output.servers[1]['fully_qualified_domain_name'] != None
|
||||
|
||||
- name: Delete instance of PostgreSQL Server -- check mode
|
||||
azure_rm_postgresqlserver:
|
||||
resource_group: "{{ resource_group }}"
|
||||
|
|
|
|||
Loading…
Reference in a new issue