mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
Adding new module azure_rm_networkinterace_facts (#3460)
* Adding new Azure module. * Updating based on PR comments
This commit is contained in:
Chris Houseknecht
Matt Clay
parent
9406855d6b
commit
a09569c150
1 changed files with 226 additions and 0 deletions
|
|
@ -0,0 +1,226 @@
|
|||
#!/usr/bin/python
|
||||
#
|
||||
# Copyright (c) 2016 Matt Davis, <mdavis@ansible.com>
|
||||
# Chris Houseknecht, <house@redhat.com>
|
||||
#
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
#
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: azure_rm_networkinterface_facts
|
||||
|
||||
version_added: "2.1"
|
||||
|
||||
short_description: Get network interface facts.
|
||||
|
||||
description:
|
||||
- Get facts for a specific network interface or all network interfaces within a resource group.
|
||||
|
||||
options:
|
||||
name:
|
||||
description:
|
||||
- Only show results for a specific network interface.
|
||||
required: false
|
||||
default: null
|
||||
resource_group:
|
||||
description:
|
||||
- Name of the resource group containing the network interface(s). Required when searching by name.
|
||||
required: false
|
||||
default: null
|
||||
tags:
|
||||
description:
|
||||
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
|
||||
required: false
|
||||
default: null
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
|
||||
author:
|
||||
- "Chris Houseknecht (@chouseknecht)"
|
||||
- "Matt Davis (@nitzmahone)"
|
||||
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Get facts for one network interface
|
||||
azure_rm_networkinterface_facts:
|
||||
resource_group: Testing
|
||||
name: nic001
|
||||
|
||||
- name: Get network interfaces within a resource group
|
||||
azure_rm_networkinterface_facts:
|
||||
resource_group: Testing
|
||||
|
||||
- name: Get network interfaces by tag
|
||||
azure_rm_networkinterface_facts:
|
||||
resource_group: Testing
|
||||
tags:
|
||||
- testing
|
||||
- foo:bar
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
changed:
|
||||
description: Whether or not the object was changed.
|
||||
returned: always
|
||||
type: bool
|
||||
sample: False
|
||||
objects:
|
||||
description: List containing a set of facts for each selected object.
|
||||
returned: always
|
||||
type: list
|
||||
sample: [{
|
||||
"dns_settings": {
|
||||
"applied_dns_servers": [],
|
||||
"dns_servers": [],
|
||||
"internal_dns_name_label": null,
|
||||
"internal_fqdn": null
|
||||
},
|
||||
"enable_ip_forwarding": false,
|
||||
"etag": "W/\"59726bfc-08c4-44ed-b900-f6a559876a9d\"",
|
||||
"id": "/subscriptions/3f7e29ba-24e0-42f6-8d9c-5149a14bda37/resourceGroups/Testing/providers/Microsoft.Network/networkInterfaces/nic003",
|
||||
"ip_configuration": {
|
||||
"name": "default",
|
||||
"private_ip_address": "10.10.0.4",
|
||||
"private_ip_allocation_method": "Dynamic",
|
||||
"public_ip_address": {
|
||||
"id": "/subscriptions/3f7e29ba-24e0-42f6-8d9c-5149a14bda37/resourceGroups/Testing/providers/Microsoft.Network/publicIPAddresses/publicip001",
|
||||
"name": "publicip001"
|
||||
},
|
||||
"subnet": {
|
||||
"id": "/subscriptions/3f7e29ba-24e0-42f6-8d9c-5149a14bda37/resourceGroups/Testing/providers/Microsoft.Network/virtualNetworks/vnet001/subnets/subnet001",
|
||||
"name": "subnet001",
|
||||
"virtual_network_name": "vnet001"
|
||||
}
|
||||
},
|
||||
"location": "westus",
|
||||
"mac_address": null,
|
||||
"name": "nic003",
|
||||
"network_security_group": {
|
||||
"id": "/subscriptions/3f7e29ba-24e0-42f6-8d9c-5149a14bda37/resourceGroups/Testing/providers/Microsoft.Network/networkSecurityGroups/secgroup001",
|
||||
"name": "secgroup001"
|
||||
},
|
||||
"primary": null,
|
||||
"provisioning_state": "Succeeded",
|
||||
"tags": {},
|
||||
"type": "Microsoft.Network/networkInterfaces"
|
||||
}]
|
||||
'''
|
||||
|
||||
from ansible.module_utils.basic import *
|
||||
from ansible.module_utils.azure_rm_common import *
|
||||
|
||||
try:
|
||||
from msrestazure.azure_exceptions import CloudError
|
||||
from azure.common import AzureMissingResourceHttpError, AzureHttpError
|
||||
except:
|
||||
# This is handled in azure_rm_common
|
||||
pass
|
||||
|
||||
|
||||
AZURE_OBJECT_CLASS = 'NetworkInterface'
|
||||
|
||||
|
||||
class AzureRMNetworkInterfaceFacts(AzureRMModuleBase):
|
||||
|
||||
def __init__(self):
|
||||
|
||||
self.module_arg_spec = dict(
|
||||
name=dict(type='str'),
|
||||
resource_group=dict(type='str'),
|
||||
tags=dict(type='list')
|
||||
)
|
||||
|
||||
self.results = dict(
|
||||
changed=False,
|
||||
objects=[]
|
||||
)
|
||||
|
||||
self.name = None
|
||||
self.resource_group = None
|
||||
self.tags = None
|
||||
|
||||
super(AzureRMNetworkInterfaceFacts, self).__init__(self.module_arg_spec,
|
||||
supports_tags=False,
|
||||
facts_module=True
|
||||
)
|
||||
|
||||
def exec_module(self, **kwargs):
|
||||
|
||||
for key in self.module_arg_spec:
|
||||
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['objects'] = self.get_item()
|
||||
elif self.resource_group:
|
||||
self.results['objects'] = self.list_resource_group()
|
||||
else:
|
||||
self.results['objects'] = self.list_all()
|
||||
|
||||
return self.results
|
||||
|
||||
def get_item(self):
|
||||
self.log('Get properties for {0}'.format(self.name))
|
||||
result = []
|
||||
item = None
|
||||
try:
|
||||
item = self.network_client.network_interfaces.get(self.resource_group, self.name)
|
||||
except:
|
||||
pass
|
||||
|
||||
if item and self.has_tags(item.tags, self.tags):
|
||||
result = [self.serialize_obj(item, AZURE_OBJECT_CLASS)]
|
||||
|
||||
return result
|
||||
|
||||
def list_resource_group(self):
|
||||
self.log('List for resource group')
|
||||
try:
|
||||
response = self.network_client.network_interfaces.list(self.resource_group)
|
||||
except Exception as exc:
|
||||
self.fail("Error listing by resource group {0} - {1}".format(self.resource_group, str(exc)))
|
||||
|
||||
results = []
|
||||
for item in response:
|
||||
if self.has_tags(item.tags, self.tags):
|
||||
results.append(self.serialize_obj(item, AZURE_OBJECT_CLASS))
|
||||
return results
|
||||
|
||||
def list_all(self):
|
||||
self.log('List all')
|
||||
try:
|
||||
response = self.network_client.network_interfaces.list_all()
|
||||
except Exception as exc:
|
||||
self.fail("Error listing all - {1}".format(self.resource_group, str(exc)))
|
||||
|
||||
results = []
|
||||
for item in response:
|
||||
if self.has_tags(item.tags, self.tags):
|
||||
results.append(self.serialize_obj(item, AZURE_OBJECT_CLASS))
|
||||
return results
|
||||
|
||||
|
||||
def main():
|
||||
AzureRMNetworkInterfaceFacts()
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
|
||||
Loading…
Reference in a new issue