-
Notifications
You must be signed in to change notification settings - Fork 23.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
adding module azure_rm_virtualmachinescalesetinstance_facts #50440
Merged
zikalino
merged 10 commits into
ansible:devel
from
VSChina:adding-scaleset-instances-facts
Jan 7, 2019
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
99d3619
adding module
45e63a2
fixing & adding test
de4df6d
fixes
bcb1f29
more fixes
5adc68f
updated name
a0d74f7
fixed tests
108bde4
fix return value
4b399e7
added alias
279bc06
updated facts
78421eb
+ small fix
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
227 changes: 227 additions & 0 deletions
227
lib/ansible/modules/cloud/azure/azure_rm_virtualmachinescalesetinstance_facts.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,227 @@ | ||
#!/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_virtualmachinescalesetinstance_facts | ||
version_added: "2.8" | ||
short_description: Get Azure Virtual Machine Scale Set Instance facts. | ||
description: | ||
- Get facts of Azure Virtual Machine Scale Set VMs. | ||
|
||
options: | ||
resource_group: | ||
description: | ||
- The name of the resource group. | ||
required: True | ||
vmss_name: | ||
description: | ||
- The name of the VM scale set. | ||
required: True | ||
instance_id: | ||
description: | ||
- The instance ID of the virtual machine. | ||
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: List VM instances in Virtual Machine ScaleSet | ||
azure_rm_computevirtualmachinescalesetinstance_facts: | ||
resource_group: myResourceGroup | ||
vmss_name: myVMSS | ||
''' | ||
|
||
RETURN = ''' | ||
instances: | ||
description: A list of dictionaries containing facts for Virtual Machine Scale Set VM. | ||
returned: always | ||
type: complex | ||
contains: | ||
id: | ||
description: | ||
- Resource Id | ||
returned: always | ||
type: str | ||
sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/my | ||
VMSS/virtualMachines/2" | ||
tags: | ||
description: | ||
- Resource tags | ||
returned: always | ||
type: complex | ||
sample: { 'tag1': 'abc' } | ||
instance_id: | ||
description: | ||
- Virtual Machine instance Id | ||
returned: always | ||
type: str | ||
sample: 0 | ||
name: | ||
description: | ||
- Virtual Machine name | ||
returned: always | ||
type: str | ||
sample: myVMSS_2 | ||
latest_model: | ||
description: | ||
- Is latest model applied? | ||
returned: always | ||
type: bool | ||
sample: True | ||
provisioning_state: | ||
description: | ||
- Provisioning state of the Virtual Machine | ||
returned: always | ||
type: str | ||
sample: Succeeded | ||
power_state: | ||
description: | ||
- Provisioning state of the Virtual Machine | ||
returned: always | ||
type: str | ||
sample: running | ||
vm_id: | ||
description: | ||
- Virtual Machine Id | ||
returned: always | ||
type: str | ||
sample: 94a141a9-4530-46ac-b151-2c7ff09aa823 | ||
''' | ||
|
||
from ansible.module_utils.azure_rm_common import AzureRMModuleBase | ||
|
||
try: | ||
from msrestazure.azure_exceptions import CloudError | ||
from azure.mgmt.compute import ComputeManagementClient | ||
from msrest.serialization import Model | ||
except ImportError: | ||
# This is handled in azure_rm_common | ||
pass | ||
|
||
|
||
class AzureRMVirtualMachineScaleSetVMFacts(AzureRMModuleBase): | ||
def __init__(self): | ||
# define user inputs into argument | ||
self.module_arg_spec = dict( | ||
resource_group=dict( | ||
type='str', | ||
required=True | ||
), | ||
vmss_name=dict( | ||
type='str', | ||
required=True | ||
), | ||
instance_id=dict( | ||
type='str' | ||
), | ||
tags=dict( | ||
type='list' | ||
) | ||
) | ||
# store the results of the module operation | ||
self.results = dict( | ||
changed=False | ||
) | ||
self.mgmt_client = None | ||
self.resource_group = None | ||
self.vmss_name = None | ||
self.instance_id = None | ||
self.tags = None | ||
super(AzureRMVirtualMachineScaleSetVMFacts, 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]) | ||
self.mgmt_client = self.get_mgmt_svc_client(ComputeManagementClient, | ||
base_url=self._cloud_environment.endpoints.resource_manager) | ||
|
||
if (self.instance_id is None): | ||
self.results['instances'] = self.list() | ||
else: | ||
self.results['instances'] = self.get() | ||
return self.results | ||
|
||
def get(self): | ||
response = None | ||
results = [] | ||
try: | ||
response = self.mgmt_client.virtual_machine_scale_set_vms.get(resource_group_name=self.resource_group, | ||
vm_scale_set_name=self.vmss_name, | ||
instance_id=self.instance_id) | ||
self.log("Response : {0}".format(response)) | ||
except CloudError as e: | ||
self.log('Could not get facts for Virtual Machine Scale Set VM.') | ||
|
||
if response and self.has_tags(response.tags, self.tags): | ||
results.append(self.format_response(response)) | ||
|
||
return results | ||
|
||
def list(self): | ||
items = None | ||
try: | ||
items = self.mgmt_client.virtual_machine_scale_set_vms.list(resource_group_name=self.resource_group, | ||
virtual_machine_scale_set_name=self.vmss_name) | ||
self.log("Response : {0}".format(items)) | ||
except CloudError as e: | ||
self.log('Could not get facts for Virtual Machine ScaleSet VM.') | ||
|
||
results = [] | ||
for item in items: | ||
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() | ||
|
||
iv = self.mgmt_client.virtual_machine_scale_set_vms.get_instance_view(resource_group_name=self.resource_group, | ||
vm_scale_set_name=self.vmss_name, | ||
instance_id=d.get('instance_id', None)).as_dict() | ||
power_state = "" | ||
for index in range(len(iv['statuses'])): | ||
code = iv['statuses'][index]['code'].split('/') | ||
if code[0] == 'PowerState': | ||
power_state = code[1] | ||
break | ||
d = { | ||
'resource_group': self.resource_group, | ||
'id': d.get('id', None), | ||
'tags': d.get('tags', None), | ||
'instance_id': d.get('instance_id', None), | ||
'latest_model': d.get('latest_model_applied', None), | ||
'name': d.get('name', None), | ||
'provisioning_state': d.get('provisioning_state', None), | ||
'power_state': power_state, | ||
'vm_id': d.get('vm_id', None) | ||
} | ||
return d | ||
|
||
|
||
def main(): | ||
AzureRMVirtualMachineScaleSetVMFacts() | ||
|
||
|
||
if __name__ == '__main__': | ||
main() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
could you pls add status(powerstate) in facts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
added