Support curated return value for network interface and refine test (#50482)

This commit is contained in:
Yuwei Zhou 2019-01-14 14:17:31 +08:00 committed by Yunge Zhu
commit eaf9da4dff
3 changed files with 377 additions and 380 deletions

View file

@ -137,6 +137,9 @@ options:
public_ip_address_name:
description:
- Name of the public ip address. None for disable ip address.
aliases:
- public_ip_address
- public_ip_name
public_ip_allocation_method:
description:
- public ip allocation method.

View file

@ -104,6 +104,95 @@ azure_networkinterfaces:
"tags": {},
"type": "Microsoft.Network/networkInterfaces"
}]
networkinterfaces:
description: List of network interface dict, the dict contains parameters can be passed to C(azure_rm_networkinterface) module.
type: list
returned: always
contains:
id:
description:
- Id of the network interface.
resource_group:
description:
- Name of a resource group where the network interface exists.
name:
description:
- Name of the network interface.
location:
description:
- Azure location.
virtual_network:
description:
- An existing virtual network with which the network interface will be associated.
- It is a dict which contains C(name) and C(resource_group) of the virtual network.
subnet:
description:
- Name of an existing subnet within the specified virtual network.
tags:
description:
- Tags of the network interface.
ip_configurations:
description:
- List of ip configuration if contains mutilple configuration.
contains:
name:
description:
- Name of the ip configuration.
private_ip_address:
description:
- Private ip address for the ip configuration.
private_ip_allocation_method:
description:
- private ip allocation method.
public_ip_address:
description:
- Name of the public ip address. None for disable ip address.
public_ip_allocation_method:
description:
- public ip allocation method.
load_balancer_backend_address_pools:
description:
- List of an existing load-balancer backend address pool id to associate with the network interface.
primary:
description:
- Whether the ip configuration is the primary one in the list.
enable_accelerated_networking:
description:
- Specifies whether the network interface should be created with the accelerated networking feature or not
create_with_security_group:
description:
- Specifies whether a default security group should be be created with the NIC. Only applies when creating a new NIC.
type: bool
security_group:
description:
- A security group resource ID with which to associate the network interface.
enable_ip_forwarding:
description:
- Whether to enable IP forwarding
dns_servers:
description:
- Which DNS servers should the NIC lookup
- List of IP's
mac_address:
description:
- The MAC address of the network interface.
provisioning_state:
description:
- The provisioning state of the network interface.
dns_settings:
description:
- The DNS settings in network interface.
contains:
dns_servers:
description: List of DNS servers IP addresses.
applied_dns_servers:
description:
- If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers
from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.
internal_dns_name_label:
description: Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.
internal_fqdn:
description: Fully qualified DNS name supporting internal communications between VMs in the same virtual network.
''' # NOQA
try:
from msrestazure.azure_exceptions import CloudError
@ -112,12 +201,55 @@ except Exception:
# This is handled in azure_rm_common
pass
from ansible.module_utils.azure_rm_common import AzureRMModuleBase
from ansible.module_utils.azure_rm_common import AzureRMModuleBase, azure_id_to_dict
AZURE_OBJECT_CLASS = 'NetworkInterface'
def nic_to_dict(nic):
ip_configurations = [
dict(
name=config.name,
private_ip_address=config.private_ip_address,
private_ip_allocation_method=config.private_ip_allocation_method,
primary=config.primary,
load_balancer_backend_address_pools=([item.id for item in config.load_balancer_backend_address_pools]
if config.load_balancer_backend_address_pools else None),
public_ip_address=config.public_ip_address.id if config.public_ip_address else None,
public_ip_allocation_method=config.public_ip_address.public_ip_allocation_method if config.public_ip_address else None
) for config in nic.ip_configurations
]
config = nic.ip_configurations[0] if len(nic.ip_configurations) > 0 else None
subnet_dict = azure_id_to_dict(config.subnet.id) if config and config.subnet else None
subnet = subnet_dict.get('subnets') if subnet_dict else None
virtual_network = dict(
resource_group=subnet_dict.get('resourceGroups'),
name=subnet_dict.get('virtualNetworks')) if subnet_dict else None
return dict(
id=nic.id,
resource_group=azure_id_to_dict(nic.id).get('resourceGroups'),
name=nic.name,
subnet=subnet,
virtual_network=virtual_network,
location=nic.location,
tags=nic.tags,
security_group=nic.network_security_group.id if nic.network_security_group else None,
dns_settings=dict(
dns_servers=nic.dns_settings.dns_servers,
applied_dns_servers=nic.dns_settings.applied_dns_servers,
internal_dns_name_label=nic.dns_settings.internal_dns_name_label,
internal_fqdn=nic.dns_settings.internal_fqdn
),
ip_configurations=ip_configurations,
mac_address=nic.mac_address,
enable_ip_forwarding=nic.enable_ip_forwarding,
provisioning_state=nic.provisioning_state,
enable_accelerated_networking=nic.enable_accelerated_networking,
dns_servers=nic.dns_settings.dns_servers,
)
class AzureRMNetworkInterfaceFacts(AzureRMModuleBase):
def __init__(self):
@ -150,57 +282,50 @@ class AzureRMNetworkInterfaceFacts(AzureRMModuleBase):
if self.name and not self.resource_group:
self.fail("Parameter error: resource group required when filtering by name.")
if self.name:
self.results['ansible_facts']['azure_networkinterfaces'] = self.get_item()
elif self.resource_group:
self.results['ansible_facts']['azure_networkinterfaces'] = self.list_resource_group()
else:
self.results['ansible_facts']['azure_networkinterfaces'] = self.list_all()
results = []
if self.name:
results = self.get_item()
elif self.resource_group:
results = self.list_resource_group()
else:
results = self.list_all()
self.results['ansible_facts']['azure_networkinterfaces'] = self.serialize_nics(results)
self.results['networkinterfaces'] = self.to_dict_list(results)
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 Exception:
pass
if item and self.has_tags(item.tags, self.tags):
nic = self.serialize_obj(item, AZURE_OBJECT_CLASS)
result = [nic]
return result
return [item] if item and self.has_tags(item.tags, self.tags) else []
def list_resource_group(self):
self.log('List for resource group')
try:
response = self.network_client.network_interfaces.list(self.resource_group)
return [item for item in response if self.has_tags(item.tags, self.tags)]
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):
nic = self.serialize_obj(item, AZURE_OBJECT_CLASS)
results.append(nic)
return results
def list_all(self):
self.log('List all')
try:
response = self.network_client.network_interfaces.list_all()
return [item for item in response if self.has_tags(item.tags, self.tags)]
except Exception as exc:
self.fail("Error listing all - {0}".format(str(exc)))
results = []
for item in response:
if self.has_tags(item.tags, self.tags):
nic = self.serialize_obj(item, AZURE_OBJECT_CLASS)
results.append(nic)
return results
def serialize_nics(self, raws):
return [self.serialize_obj(item, AZURE_OBJECT_CLASS) for item in raws] if raws else []
def to_dict_list(self, raws):
return [nic_to_dict(item) for item in raws] if raws else []
def main():