#!/usr/bin/python # # Copyright (c) 2018 Yuwei Zhou, # # 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_route version_added: "0.1.2" short_description: Manage Azure route resource description: - Create, update or delete a route. options: resource_group: description: - Name of resource group. required: true type: str name: description: - Name of the route. required: true type: str state: description: - Assert the state of the route. Use C(present) to create or update and C(absent) to delete. default: present type: str choices: - absent - present address_prefix: description: - The destination CIDR to which the route applies. type: str next_hop_type: description: - The type of Azure hop the packet should be sent to. type: str choices: - virtual_network_gateway - vnet_local - internet - virtual_appliance - none default: 'none' next_hop_ip_address: description: - The IP address packets should be forwarded to. - Next hop values are only allowed in routes where the next hop type is VirtualAppliance. type: str route_table_name: description: - The name of the route table. required: true type: str extends_documentation_fragment: - azure.azcollection.azure - azure.azcollection.azure_tags author: - Yuwei Zhou (@yuwzho) ''' EXAMPLES = ''' - name: Create a route azure_rm_route: resource_group: myResourceGroup name: myRoute address_prefix: 10.1.0.0/16 next_hop_type: virtual_network_gateway route_table_name: table - name: Delete a route azure_rm_route: resource_group: myResourceGroup name: myRoute route_table_name: table state: absent ''' RETURN = ''' id: description: - Current state of the route. returned: success type: str sample: "/subscriptions/xxxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/routeTables/tableb57/routes/routeb57" ''' try: from ansible_collections.azure.azcollection.plugins.module_utils.azure_rm_common import AzureRMModuleBase from azure.core.exceptions import ResourceNotFoundError except ImportError: # This is handled in azure_rm_common pass from ansible.module_utils.common.dict_transformations import _snake_to_camel class AzureRMRoute(AzureRMModuleBase): def __init__(self): self.module_arg_spec = dict( resource_group=dict(type='str', required=True), name=dict(type='str', required=True), state=dict(type='str', default='present', choices=['present', 'absent']), address_prefix=dict(type='str'), next_hop_type=dict(type='str', choices=['virtual_network_gateway', 'vnet_local', 'internet', 'virtual_appliance', 'none'], default='none'), next_hop_ip_address=dict(type='str'), route_table_name=dict(type='str', required=True) ) required_if = [ ('state', 'present', ['next_hop_type']) ] self.resource_group = None self.name = None self.state = None self.address_prefix = None self.next_hop_type = None self.next_hop_ip_address = None self.route_table_name = None self.results = dict( changed=False, id=None ) super(AzureRMRoute, self).__init__(self.module_arg_spec, required_if=required_if, supports_check_mode=True) def exec_module(self, **kwargs): for key in list(self.module_arg_spec.keys()): setattr(self, key, kwargs[key]) result = dict() changed = False self.next_hop_type = _snake_to_camel(self.next_hop_type, capitalize_first=True) result = self.get_route() if self.state == 'absent' and result: changed = True if not self.check_mode: self.delete_route() elif self.state == 'present': if not result: changed = True # create new route else: # check update if result.next_hop_type != self.next_hop_type: self.log('Update: {0} next_hop_type from {1} to {2}'.format(self.name, result.next_hop_type, self.next_hop_type)) changed = True if result.next_hop_ip_address != self.next_hop_ip_address: self.log('Update: {0} next_hop_ip_address from {1} to {2}'.format(self.name, result.next_hop_ip_address, self.next_hop_ip_address)) changed = True if result.address_prefix != self.address_prefix: self.log('Update: {0} address_prefix from {1} to {2}'.format(self.name, result.address_prefix, self.address_prefix)) changed = True if changed: result = self.network_models.Route(name=self.name, address_prefix=self.address_prefix, next_hop_type=self.next_hop_type, next_hop_ip_address=self.next_hop_ip_address) if not self.check_mode: result = self.create_or_update_route(result) self.results['id'] = result.id if result else None self.results['changed'] = changed return self.results def create_or_update_route(self, param): try: poller = self.network_client.routes.begin_create_or_update(self.resource_group, self.route_table_name, self.name, param) return self.get_poller_result(poller) except Exception as exc: self.fail("Error creating or updating route {0} - {1}".format(self.name, str(exc))) def delete_route(self): try: poller = self.network_client.routes.begin_delete(self.resource_group, self.route_table_name, self.name) result = self.get_poller_result(poller) return result except Exception as exc: self.fail("Error deleting route {0} - {1}".format(self.name, str(exc))) def get_route(self): try: return self.network_client.routes.get(self.resource_group, self.route_table_name, self.name) except ResourceNotFoundError as cloud_err: # Return None iff the resource is not found if cloud_err.status_code == 404: self.log('{0}'.format(str(cloud_err))) return None self.fail('Error: failed to get resource {0} - {1}'.format(self.name, str(cloud_err))) except Exception as exc: self.fail('Error: failed to get resource {0} - {1}'.format(self.name, str(exc))) def main(): AzureRMRoute() if __name__ == '__main__': main()