379 lines
12 KiB
Python
379 lines
12 KiB
Python
#!/usr/bin/python
|
|
#
|
|
# Copyright (c) 2018 Hai Cao, <t-haicao@microsoft.com>, Yunge Zhu <yungez@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_trafficmanagerprofile_facts
|
|
|
|
version_added: "2.7"
|
|
|
|
short_description: Get Azure Traffic Manager profile facts
|
|
|
|
description:
|
|
- Get facts for a Azure specific Traffic Manager profile or all Traffic Manager profiles.
|
|
|
|
options:
|
|
name:
|
|
description:
|
|
- Limit results to a specific Traffic Manager profile.
|
|
resource_group:
|
|
description:
|
|
- The resource group to search for the desired Traffic Manager profile
|
|
tags:
|
|
description:
|
|
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
|
|
|
|
extends_documentation_fragment:
|
|
- azure
|
|
|
|
author:
|
|
- "Hai Cao (@caohai) <t-haicao@microsoft.com>"
|
|
- "Yunge Zhu (@yungezz) <yungez@microsoft.com>"
|
|
'''
|
|
|
|
EXAMPLES = '''
|
|
- name: Get facts for one Traffic Manager profile
|
|
azure_rm_trafficmanager_facts:
|
|
name: Testing
|
|
resource_group: TestRG
|
|
|
|
- name: Get facts for all Traffic Manager profiles
|
|
azure_rm_trafficmanager_facts:
|
|
|
|
- name: Get facts by tags
|
|
azure_rm_trafficmanager_facts:
|
|
tags:
|
|
- Environment:Test
|
|
'''
|
|
|
|
RETURN = '''
|
|
tms:
|
|
description: List of Traffic Manager profiles.
|
|
returned: always
|
|
type: complex
|
|
contains:
|
|
resource_group:
|
|
description:
|
|
- Name of a resource group where the Traffic Manager profile exists.
|
|
returned: always
|
|
type: str
|
|
sample: testGroup
|
|
name:
|
|
description:
|
|
- Name of the Traffic Manager profile.
|
|
returned: always
|
|
type: str
|
|
sample: testTm
|
|
state:
|
|
description:
|
|
- The state of the Traffic Manager profile.
|
|
type: str
|
|
sample: present
|
|
location:
|
|
description:
|
|
- Location of the Traffic Manager profile.
|
|
type: str
|
|
sample: global
|
|
profile_status:
|
|
description:
|
|
- The status of the Traffic Manager profile.
|
|
type: str
|
|
sample: Enabled
|
|
routing_method:
|
|
description:
|
|
- The traffic routing method of the Traffic Manager profile.
|
|
type: str
|
|
sample: performance
|
|
dns_config:
|
|
description:
|
|
- The DNS settings of the Traffic Manager profile.
|
|
type: complex
|
|
sample:
|
|
relative_name: testTm
|
|
fqdn: testTm.trafficmanager.net
|
|
ttl: 60
|
|
monitor_config:
|
|
description:
|
|
- The endpoint monitoring settings of the Traffic Manager profile.
|
|
type: complex
|
|
contains:
|
|
protocol:
|
|
description:
|
|
- The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health.
|
|
type: str
|
|
sample: HTTP
|
|
port:
|
|
description:
|
|
- The TCP port used to probe for endpoint health.
|
|
type: int
|
|
sample: 80
|
|
path:
|
|
description:
|
|
- The path relative to the endpoint domain name used to probe for endpoint health.
|
|
type: str
|
|
sample: /
|
|
interval:
|
|
description:
|
|
- The monitor interval for endpoints in this profile in seconds.
|
|
type: int
|
|
sample: 10
|
|
timeout:
|
|
description:
|
|
- The monitor timeout for endpoints in this profile in seconds.
|
|
type: int
|
|
sample: 30
|
|
tolerated_failures:
|
|
description:
|
|
- The number of consecutive failed health check before declaring an endpoint Degraded after the next failed health check.
|
|
type: int
|
|
sample: 3
|
|
endpoints:
|
|
description:
|
|
- The list of endpoints in the Traffic Manager profile.
|
|
type: list
|
|
element: complex
|
|
contains:
|
|
id:
|
|
description:
|
|
- Fully qualified resource Id for the resource.
|
|
type: str
|
|
sample: /subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/tmt/providers/Microsoft.Network/trafficManagerProfiles/tmtest/externalEndpoints/e1
|
|
name:
|
|
description:
|
|
- The name of the endpoint.
|
|
type: str
|
|
sample: e1
|
|
type:
|
|
description:
|
|
- The type of the endpoint.
|
|
type: str
|
|
sample: external_endpoints
|
|
target_resource_id:
|
|
description:
|
|
- The Azure Resource URI of the of the endpoint.
|
|
type: str
|
|
sample: /subscriptions/XXXXXX...XXXXXXXXX/resourceGroups/vscjavaci/providers/Microsoft.ClassicCompute/domainNames/vscjavaci
|
|
target:
|
|
description:
|
|
- The fully-qualified DNS name of the endpoint.
|
|
type: str
|
|
sample: 8.8.8.8
|
|
status:
|
|
description:
|
|
- The status of the endpoint.
|
|
type: str
|
|
sample: Enabled
|
|
weight:
|
|
description:
|
|
- The weight of this endpoint when the profile has routing_method C(weighted).
|
|
type: int
|
|
sample: 10
|
|
priority:
|
|
description:
|
|
- The priority of this endpoint when the profile has routing_method C(priority).
|
|
type: str
|
|
sample: 3
|
|
location:
|
|
description:
|
|
- The location of endpoints when type is C(external_endpoints) or C(nested_endpoints), and profile routing_method is (performance).
|
|
type: str
|
|
sample: East US
|
|
min_child_endpoints:
|
|
description:
|
|
- The minimum number of endpoints that must be available in the child profile to make the parent profile available.
|
|
type: int
|
|
sample: 3
|
|
geo_mapping:
|
|
description:
|
|
- The list of countries/regions mapped to this endpoint when the profile has routing_method C(geographic).
|
|
type: list
|
|
sample: [
|
|
"GEO-NA",
|
|
"GEO-AS"
|
|
]
|
|
'''
|
|
|
|
from ansible.module_utils.azure_rm_common import AzureRMModuleBase
|
|
from ansible.module_utils.common.dict_transformations import _camel_to_snake
|
|
|
|
try:
|
|
from msrestazure.azure_exceptions import CloudError
|
|
from azure.common import AzureHttpError
|
|
except:
|
|
# handled in azure_rm_common
|
|
pass
|
|
|
|
import re
|
|
|
|
AZURE_OBJECT_CLASS = 'trafficManagerProfiles'
|
|
|
|
|
|
def serialize_endpoint(endpoint):
|
|
result = dict(
|
|
id=endpoint.id,
|
|
name=endpoint.name,
|
|
target_resource_id=endpoint.target_resource_id,
|
|
target=endpoint.target,
|
|
status=endpoint.endpoint_status,
|
|
weight=endpoint.weight,
|
|
priority=endpoint.priority,
|
|
location=endpoint.endpoint_location,
|
|
min_child_endpoints=endpoint.min_child_endpoints,
|
|
geo_mapping=endpoint.geo_mapping,
|
|
)
|
|
|
|
if endpoint.type:
|
|
result['type'] = _camel_to_snake(endpoint.type.split("/")[-1])
|
|
|
|
return result
|
|
|
|
|
|
class AzureRMTrafficManagerProfileFacts(AzureRMModuleBase):
|
|
"""Utility class to get Azure Traffic Manager profile facts"""
|
|
|
|
def __init__(self):
|
|
|
|
self.module_args = dict(
|
|
name=dict(type='str'),
|
|
resource_group=dict(type='str'),
|
|
tags=dict(type='list')
|
|
)
|
|
|
|
self.results = dict(
|
|
changed=False,
|
|
tms=[]
|
|
)
|
|
|
|
self.name = None
|
|
self.resource_group = None
|
|
self.tags = None
|
|
|
|
super(AzureRMTrafficManagerProfileFacts, self).__init__(
|
|
derived_arg_spec=self.module_args,
|
|
supports_tags=False,
|
|
facts_module=True
|
|
)
|
|
|
|
def exec_module(self, **kwargs):
|
|
|
|
for key in self.module_args:
|
|
setattr(self, key, kwargs[key])
|
|
|
|
if self.name and not self.resource_group:
|
|
self.fail("Parameter error: resource group required when filtering by name.")
|
|
|
|
if self.name:
|
|
self.results['tms'] = self.get_item()
|
|
elif self.resource_group:
|
|
self.results['tms'] = self.list_resource_group()
|
|
else:
|
|
self.results['tms'] = self.list_all()
|
|
|
|
return self.results
|
|
|
|
def get_item(self):
|
|
"""Get a single Azure Traffic Manager profile"""
|
|
|
|
self.log('Get properties for {0}'.format(self.name))
|
|
|
|
item = None
|
|
result = []
|
|
|
|
try:
|
|
item = self.traffic_manager_management_client.profiles.get(
|
|
self.resource_group, self.name)
|
|
except CloudError:
|
|
pass
|
|
|
|
if item and self.has_tags(item.tags, self.tags):
|
|
result = [self.serialize_tm(item)]
|
|
|
|
return result
|
|
|
|
def list_resource_group(self):
|
|
"""Get all Azure Traffic Managers profiles within a resource group"""
|
|
|
|
self.log('List all Azure Traffic Managers within a resource group')
|
|
|
|
try:
|
|
response = self.traffic_manager_management_client.profiles.list_by_resource_group(
|
|
self.resource_group)
|
|
except AzureHttpError as exc:
|
|
self.fail('Failed to list all items - {0}'.format(str(exc)))
|
|
|
|
results = []
|
|
for item in response:
|
|
if self.has_tags(item.tags, self.tags):
|
|
results.append(self.serialize_tm(item))
|
|
|
|
return results
|
|
|
|
def list_all(self):
|
|
"""Get all Azure Traffic Manager profiles within a subscription"""
|
|
self.log('List all Traffic Manager profiles within a subscription')
|
|
try:
|
|
response = self.traffic_manager_management_client.profiles.list_by_subscription()
|
|
except Exception as exc:
|
|
self.fail("Error listing all items - {0}".format(str(exc)))
|
|
|
|
results = []
|
|
for item in response:
|
|
if self.has_tags(item.tags, self.tags):
|
|
results.append(self.serialize_tm(item))
|
|
return results
|
|
|
|
def serialize_tm(self, tm):
|
|
'''
|
|
Convert a Traffic Manager profile object to dict.
|
|
:param tm: Traffic Manager profile object
|
|
:return: dict
|
|
'''
|
|
result = self.serialize_obj(tm, AZURE_OBJECT_CLASS)
|
|
|
|
new_result = {}
|
|
new_result['id'] = tm.id
|
|
new_result['resource_group'] = re.sub('\\/.*', '', re.sub('.*resourceGroups\\/', '', result['id']))
|
|
new_result['name'] = tm.name
|
|
new_result['state'] = 'present'
|
|
new_result['location'] = tm.location
|
|
new_result['profile_status'] = tm.profile_status
|
|
new_result['routing_method'] = tm.traffic_routing_method.lower()
|
|
new_result['dns_config'] = dict(
|
|
relative_name=tm.dns_config.relative_name,
|
|
fqdn=tm.dns_config.fqdn,
|
|
ttl=tm.dns_config.ttl
|
|
)
|
|
new_result['monitor_config'] = dict(
|
|
profile_monitor_status=tm.monitor_config.profile_monitor_status,
|
|
protocol=tm.monitor_config.protocol,
|
|
port=tm.monitor_config.port,
|
|
path=tm.monitor_config.path,
|
|
interval=tm.monitor_config.interval_in_seconds,
|
|
timeout=tm.monitor_config.timeout_in_seconds,
|
|
tolerated_failures=tm.monitor_config.tolerated_number_of_failures
|
|
)
|
|
new_result['endpoints'] = [serialize_endpoint(endpoint) for endpoint in tm.endpoints]
|
|
new_result['tags'] = tm.tags
|
|
return new_result
|
|
|
|
|
|
def main():
|
|
"""Main module execution code path"""
|
|
|
|
AzureRMTrafficManagerProfileFacts()
|
|
|
|
|
|
if __name__ == '__main__':
|
|
main()
|