#!/usr/bin/python # # Copyright (c) 2019 Zim Kalinowski, (@zikalino) # # 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_devtestlabvirtualmachine_info version_added: "0.1.2" short_description: Get Azure DevTest Lab Virtual Machine facts description: - Get facts of Azure DevTest Lab Virtual Machine. options: resource_group: description: - The name of the resource group. required: True type: str lab_name: description: - The name of the lab. required: True type: str name: description: - The name of the virtual machine. type: str tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. type: list elements: str extends_documentation_fragment: - azure.azcollection.azure author: - Zim Kalinowski (@zikalino) ''' EXAMPLES = ''' - name: Get instance of DTL Virtual Machine azure_rm_devtestlabvirtualmachine_info: resource_group: myResourceGroup lab_name: myLab name: myVm tags: - key:value ''' RETURN = ''' virtualmachines: description: - A list of dictionaries containing facts for DevTest Lab Virtual Machine. returned: always type: complex contains: id: description: - The identifier of the virtual machine. returned: always type: str sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourcegroups/myResourceGroup/providers/microsoft.devtestlab/labs/myLab/virt ualmachines/myVm" resource_group: description: - Name of the resource group. returned: always type: str sample: myResourceGroup lab_name: description: - Name of the lab. returned: always type: str sample: myLab name: description: - Name of the virtual machine. returned: always type: str sample: myVm is_authentication_with_ssh_key: description: - Indicates whether this virtual machine uses an SSH key for authentication. type: bool returned: always sample: False notes: description: - Notes of the virtual machine. returned: always type: str sample: My VM notes disallow_public_ip_address: description: - Whether public IP should be not allowed. returned: always type: bool sample: false expiration_date: description: - Virtual machine expiration date. returned: always type: str sample: "2029-02-22T01:49:12.117974Z" image: description: - Gallery image reference. returned: always type: complex contains: offer: description: - The offer of the gallery image. returned: when created from gallery image type: str sample: UbuntuServer os_type: description: - Operating system type. returned: when created from gallery image type: str sample: Linux sku: description: - The SKU of the gallery image. returned: when created from gallery image type: str sample: 20_04-lts publisher: description: - The publisher of the gallery image. returned: when created from gallery image type: str sample: Canonical version: description: - The version of the gallery image. returned: when created from gallery image type: str sample: latest os_type: description: - Operating system type. returned: always type: str sample: linux vm_size: description: - Virtual machine size. returned: always type: str sample: Standard_A2_v2 user_name: description: - Admin user name. returned: always type: str sample: dtl_admin storage_type: description: - Storage type to use for virtual machine. returned: always type: str sample: standard compute_vm_id: description: - Resource id of compute virtual machine. returned: always type: str sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myLab-myVm-097933/providers/Microsoft.Compute/virtualMachines/myVm compute_vm_resource_group: description: - Resource group where compute virtual machine is created. returned: always type: str sample: myLab-myVm-097933 compute_vm_name: description: - Name of compute virtual machine. returned: always type: str sample: myVm fqdn: description: - Fully qualified domain name. returned: always type: str sample: myvm.eastus.cloudapp.azure.com provisioning_state: description: - Provisioning state of the virtual network. returned: always type: str sample: Succeeded tags: description: - The tags of the resource. returned: always type: dict sample: "{ 'foo': 'bar' }" ''' from ansible_collections.azure.azcollection.plugins.module_utils.azure_rm_common import AzureRMModuleBase try: from azure.core.exceptions import ResourceNotFoundError from azure.mgmt.devtestlabs import DevTestLabsClient except ImportError: # This is handled in azure_rm_common pass class AzureRMDtlVirtualMachineInfo(AzureRMModuleBase): def __init__(self): # define user inputs into argument self.module_arg_spec = dict( resource_group=dict( type='str', required=True ), lab_name=dict( type='str', required=True ), name=dict( type='str' ), tags=dict( type='list', elements='str' ) ) # store the results of the module operation self.results = dict( changed=False ) self.mgmt_client = None self.resource_group = None self.lab_name = None self.name = None self.tags = None super(AzureRMDtlVirtualMachineInfo, self).__init__(self.module_arg_spec, supports_check_mode=True, supports_tags=False, facts_module=True) def exec_module(self, **kwargs): is_old_facts = self.module._name == 'azure_rm_devtestlabvirtualmachine_facts' if is_old_facts: self.module.deprecate("The 'azure_rm_devtestlabvirtualmachine_facts' module has been renamed to 'azure_rm_devtestlabvirtualmachine_info'", version=(2.9, )) for key in self.module_arg_spec: setattr(self, key, kwargs[key]) self.mgmt_client = self.get_mgmt_svc_client(DevTestLabsClient, base_url=self._cloud_environment.endpoints.resource_manager) if self.name: self.results['virtualmachines'] = self.get() else: self.results['virtualmachines'] = self.list() return self.results def get(self): response = None results = [] try: response = self.mgmt_client.virtual_machines.get(resource_group_name=self.resource_group, lab_name=self.lab_name, name=self.name) self.log("Response : {0}".format(response)) except ResourceNotFoundError as e: self.log('Could not get facts for Virtual Machine.') return None if response and self.has_tags(response.tags, self.tags): results.append(self.format_response(response)) return results def list(self): response = None results = [] try: response = self.mgmt_client.virtual_machines.list(resource_group_name=self.resource_group, lab_name=self.lab_name) self.log("Response : {0}".format(response)) except Exception as e: self.log('Could not get facts for Virtual Machine.') return None if response is not None: for item in response: if self.has_tags(item.tags, self.tags): results.append(self.format_response(item)) return results def format_response(self, item): d = item.as_dict() d = { 'id': d.get('id', None), 'resource_group': self.parse_resource_to_dict(d.get('id')).get('resource_group'), 'lab_name': self.parse_resource_to_dict(d.get('id')).get('name'), 'name': d.get('name'), 'notes': d.get('notes'), 'disallow_public_ip_address': d.get('disallow_public_ip_address'), 'expiration_date': d.get('expiration_date'), 'image': d.get('gallery_image_reference'), 'os_type': d.get('os_type').lower(), 'vm_size': d.get('size'), 'user_name': d.get('user_name'), 'storage_type': d.get('storage_type').lower(), 'compute_vm_id': d.get('compute_id'), 'compute_vm_resource_group': self.parse_resource_to_dict(d.get('compute_id')).get('resource_group'), 'compute_vm_name': self.parse_resource_to_dict(d.get('compute_id')).get('name'), 'fqdn': d.get('fqdn'), 'provisioning_state': d.get('provisioning_state'), 'tags': d.get('tags', None), 'is_authentication_with_ssh_key': d.get('is_authentication_with_ssh_key') } return d def main(): AzureRMDtlVirtualMachineInfo() if __name__ == '__main__': main()