1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
|
#!/usr/bin/python
#
# Copyright (c) 2016 Matt Davis, <mdavis@ansible.com>
# Chris Houseknecht, <house@redhat.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_publicipaddress_facts
version_added: "2.1"
short_description: Get public IP facts.
description:
- Get facts for a specific public IP or all public IPs within a resource group.
options:
name:
description:
- Only show results for a specific Public IP.
resource_group:
description:
- Limit results by resource group. Required when using name parameter.
tags:
description:
- Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
extends_documentation_fragment:
- azure
author:
- "Chris Houseknecht (@chouseknecht)"
- "Matt Davis (@nitzmahone)"
'''
EXAMPLES = '''
- name: Get facts for one Public IP
azure_rm_publicipaddress_facts:
resource_group: myResourceGroup
name: publicip001
- name: Get facts for all Public IPs within a resource groups
azure_rm_publicipaddress_facts:
resource_group: myResourceGroup
'''
RETURN = '''
azure_publicipaddresses:
description:
- List of public IP address dicts.
- Please note that this option will be deprecated in 2.10 when curated format will become the only supported format.
returned: always
type: list
example: [{
"etag": 'W/"a31a6d7d-cb18-40a5-b16d-9f4a36c1b18a"',
"id": "/subscriptions/XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXX/resourceGroups/Testing/providers/Microsoft.Network/publicIPAddresses/pip2001",
"location": "eastus2",
"name": "pip2001",
"properties": {
"idleTimeoutInMinutes": 4,
"provisioningState": "Succeeded",
"publicIPAllocationMethod": "Dynamic",
"resourceGuid": "29de82f4-a7da-440e-bd3d-9cabb79af95a"
},
"type": "Microsoft.Network/publicIPAddresses"
}]
publicipaddresses:
description:
- List of publicipaddress
- Contains the detail which matches azure_rm_publicipaddress parameters.
- Returned when the format parameter set to curated.
returned: always
type: complex
contains:
id:
description:
- Resource ID.
returned: always
type: str
name:
description:
- Name of the public ip address.
returned: always
type: str
type:
description:
- Resource type.
returned: always
type: str
location:
description:
- Resource location.
returned: always
type: str
tags:
description:
- Resource tags.
returned: always
type: complex
allocation_method:
description:
- The public IP allocation method.
- Possible values are 'static' and 'dynamic'.
returned: always
type: str
version:
description:
- The public IP address version.
- Possible values are 'ipv4' and 'ipv6'.
returned: always
type: str
dns_settings:
description:
- The FQDN of the DNS record associated with the public IP address.
returned: always
type: complex
ip_tags:
description:
- The list of tags associated with the public IP address.
returned: always
type: complex
ip_address:
description:
- The Public IP Prefix this Public IP Address should be allocated from.
returned: always
type: str
idle_timeout:
description:
- The idle timeout of the public IP address.
returned: always
type: int
provisioning_state:
description:
- he provisioning state of the PublicIP resource.
- Possible values are 'Updating', 'Deleting', and 'Failed'.
returned: always
type: str
etag:
description:
- A unique read-only string that changes whenever the resource is updated.
returned: always
type: str
sku:
description:
- The public IP address SKU.
returned: always
type: str
'''
try:
from msrestazure.azure_exceptions import CloudError
from azure.common import AzureMissingResourceHttpError, AzureHttpError
except Exception:
# This is handled in azure_rm_common
pass
from ansible.module_utils.azure_rm_common import AzureRMModuleBase
AZURE_OBJECT_CLASS = 'PublicIp'
class AzureRMPublicIPFacts(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,
ansible_facts=dict(azure_publicipaddresses=[])
)
self.name = None
self.resource_group = None
self.tags = None
super(AzureRMPublicIPFacts, 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])
result = []
if self.name and not self.resource_group:
self.fail("Parameter error: resource group required when filtering by name.")
if self.name:
result = self.get_item()
elif self.resource_group:
result = self.list_resource_group()
else:
result = self.list_all()
raw = self.filter(result)
self.results['ansible_facts']['azure_publicipaddresses'] = self.serialize(raw)
self.results['publicipaddresses'] = self.format(raw)
return self.results
def format(self, raw):
return [self.pip_to_dict(item) for item in raw]
def serialize(self, raw):
results = []
for item in raw:
pip = self.serialize_obj(item, AZURE_OBJECT_CLASS)
pip['name'] = item.name
pip['type'] = item.type
results.append(pip)
return results
def filter(self, response):
return [item for item in response if self.has_tags(item.tags, self.tags)]
# duplicate with azure_rm_publicipaddress
def pip_to_dict(self, pip):
result = dict(
id=pip.id,
name=pip.name,
type=pip.type,
location=pip.location,
tags=pip.tags,
allocation_method=pip.public_ip_allocation_method.lower(),
version=pip.public_ip_address_version.lower(),
dns_settings=dict(),
ip_tags=dict(),
ip_address=pip.ip_address,
idle_timeout=pip.idle_timeout_in_minutes,
provisioning_state=pip.provisioning_state,
etag=pip.etag,
sku=pip.sku.name
)
if pip.dns_settings:
result['dns_settings']['domain_name_label'] = pip.dns_settings.domain_name_label
result['dns_settings']['fqdn'] = pip.dns_settings.fqdn
result['dns_settings']['reverse_fqdn'] = pip.dns_settings.reverse_fqdn
if pip.ip_tags:
result['ip_tags'] = [dict(type=x.ip_tag_type, value=x.tag) for x in pip.ip_tags]
return result
def get_item(self):
self.log('Get properties for {0}'.format(self.name))
item = None
try:
item = self.network_client.public_ip_addresses.get(self.resource_group, self.name)
except CloudError:
pass
return [item] if item else []
def list_resource_group(self):
self.log('List items in resource groups')
try:
response = self.network_client.public_ip_addresses.list(self.resource_group)
except AzureHttpError as exc:
self.fail("Error listing items in resource groups {0} - {1}".format(self.resource_group, str(exc)))
return response
def list_all(self):
self.log('List all items')
try:
response = self.network_client.public_ip_addresses.list_all()
except AzureHttpError as exc:
self.fail("Error listing all items - {0}".format(str(exc)))
return response
def main():
AzureRMPublicIPFacts()
if __name__ == '__main__':
main()
|
