community.general/lib/ansible/modules/cloud/azure/azure_rm_devtestlabvirtualn...

281 lines
9.7 KiB
Python

#!/usr/bin/python
#
# Copyright (c) 2019 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_devtestlabvirtualnetwork
version_added: "2.8"
short_description: Manage Azure DevTest Lab Virtual Network instance.
description:
- Create, update and delete instance of Azure DevTest Lab Virtual Network.
options:
resource_group:
description:
- The name of the resource group.
required: True
lab_name:
description:
- The name of the lab.
required: True
name:
description:
- The name of the virtual network.
required: True
location:
description:
- The location of the resource.
description:
description:
- The description of the virtual network.
state:
description:
- Assert the state of the Virtual Network.
- Use 'present' to create or update an Virtual Network and 'absent' to delete it.
default: present
choices:
- absent
- present
extends_documentation_fragment:
- azure
- azure_tags
author:
- "Zim Kalinowski (@zikalino)"
'''
EXAMPLES = '''
- name: Create (or update) Virtual Network
azure_rm_devtestlabvirtualnetwork:
resource_group: testrg
lab_name: mylab
name: myvn
description: My Lab Virtual Network
'''
RETURN = '''
id:
description:
- The identifier of the resource.
returned: always
type: str
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/testrg/providers/microsoft.devtestlab/
mylab/mylab/virtualnetworks/myvn"
external_provider_resource_id:
description:
- The identifier of external virtual network.
returned: always
type: str
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testrg/providers/Microsoft.Network/vi
rtualNetworks/myvn"
'''
import time
from ansible.module_utils.azure_rm_common import AzureRMModuleBase
from ansible.module_utils.common.dict_transformations import _snake_to_camel
try:
from msrestazure.azure_exceptions import CloudError
from msrest.polling import LROPoller
from msrestazure.azure_operation import AzureOperationPoller
from azure.mgmt.devtestlabs import DevTestLabsClient
from msrest.serialization import Model
except ImportError:
# This is handled in azure_rm_common
pass
class Actions:
NoAction, Create, Update, Delete = range(4)
class AzureRMDevTestLabVirtualNetwork(AzureRMModuleBase):
"""Configuration class for an Azure RM Virtual Network resource"""
def __init__(self):
self.module_arg_spec = dict(
resource_group=dict(
type='str',
required=True
),
lab_name=dict(
type='str',
required=True
),
name=dict(
type='str',
required=True
),
location=dict(
type='str'
),
description=dict(
type='str'
),
state=dict(
type='str',
default='present',
choices=['present', 'absent']
)
)
self.resource_group = None
self.lab_name = None
self.name = None
self.virtual_network = {}
self.results = dict(changed=False)
self.mgmt_client = None
self.state = None
self.to_do = Actions.NoAction
super(AzureRMDevTestLabVirtualNetwork, 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:
self.virtual_network[key] = kwargs[key]
response = None
self.mgmt_client = self.get_mgmt_svc_client(DevTestLabsClient,
base_url=self._cloud_environment.endpoints.resource_manager,
api_version='2018-10-15')
resource_group = self.get_resource_group(self.resource_group)
if self.virtual_network.get('location') is None:
self.virtual_network['location'] = resource_group.location
old_response = self.get_virtualnetwork()
if not old_response:
self.log("Virtual Network instance doesn't exist")
if self.state == 'absent':
self.log("Old instance didn't exist")
else:
self.to_do = Actions.Create
else:
self.log("Virtual Network instance already exists")
if self.state == 'absent':
self.to_do = Actions.Delete
elif self.state == 'present':
if self.virtual_network.get('description') is not None and self.virtual_network.get('description') != old_response.get('description'):
self.to_do = Actions.Update
if (self.to_do == Actions.Create) or (self.to_do == Actions.Update):
self.log("Need to Create / Update the Virtual Network instance")
self.results['changed'] = True
if self.check_mode:
return self.results
response = self.create_update_virtualnetwork()
self.log("Creation / Update done")
elif self.to_do == Actions.Delete:
self.log("Virtual Network instance deleted")
self.results['changed'] = True
if self.check_mode:
return self.results
self.delete_virtualnetwork()
# This currently doesnt' work as there is a bug in SDK / Service
if isinstance(response, LROPoller) or isinstance(response, AzureOperationPoller):
response = self.get_poller_result(response)
else:
self.log("Virtual Network instance unchanged")
self.results['changed'] = False
response = old_response
if self.state == 'present':
self.results.update({
'id': response.get('id', None),
'external_provider_resource_id': response.get('external_provider_resource_id', None)
})
return self.results
def create_update_virtualnetwork(self):
'''
Creates or updates Virtual Network with the specified configuration.
:return: deserialized Virtual Network instance state dictionary
'''
self.log("Creating / Updating the Virtual Network instance {0}".format(self.name))
try:
response = self.mgmt_client.virtual_networks.create_or_update(resource_group_name=self.resource_group,
lab_name=self.lab_name,
name=self.name,
virtual_network=self.virtual_network)
if isinstance(response, LROPoller) or isinstance(response, AzureOperationPoller):
response = self.get_poller_result(response)
except CloudError as exc:
self.log('Error attempting to create the Virtual Network instance.')
self.fail("Error creating the Virtual Network instance: {0}".format(str(exc)))
return response.as_dict()
def delete_virtualnetwork(self):
'''
Deletes specified Virtual Network instance in the specified subscription and resource group.
:return: True
'''
self.log("Deleting the Virtual Network instance {0}".format(self.name))
try:
response = self.mgmt_client.virtual_networks.delete(resource_group_name=self.resource_group,
lab_name=self.lab_name,
name=self.name)
except CloudError as e:
self.log('Error attempting to delete the Virtual Network instance.')
self.fail("Error deleting the Virtual Network instance: {0}".format(str(e)))
return True
def get_virtualnetwork(self):
'''
Gets the properties of the specified Virtual Network.
:return: deserialized Virtual Network instance state dictionary
'''
self.log("Checking if the Virtual Network instance {0} is present".format(self.name))
found = False
try:
response = self.mgmt_client.virtual_networks.get(resource_group_name=self.resource_group,
lab_name=self.lab_name,
name=self.name)
found = True
self.log("Response : {0}".format(response))
self.log("Virtual Network instance : {0} found".format(response.name))
except CloudError as e:
self.log('Did not find the Virtual Network instance.')
if found is True:
return response.as_dict()
return False
def main():
"""Main execution"""
AzureRMDevTestLabVirtualNetwork()
if __name__ == '__main__':
main()