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
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# (C) 2019 Red Hat Inc.
# Copyright (C) 2020 Western Telematic Inc.
#
# GNU General Public License v3.0+
#
# This program 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.
#
# (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
#
# Module to retrieve WTI Parameters from WTI OOB and PDU devices.
# CPM remote_management
#
from __future__ import absolute_import, division, print_function
__metaclass__ = type
ANSIBLE_METADATA = {
'metadata_version': '1.1',
'status': ['preview'],
'supported_by': 'community'
}
DOCUMENTATION = """
---
module: cpm_config_backup
version_added: "2.9.0"
author: "Western Telematic Inc. (@wtinetworkgear)"
short_description: Get parameters from WTI OOB and PDU devices
description:
- "Get parameters from WTI OOB and PDU devices"
options:
cpm_url:
description:
- This is the URL of the WTI device to get the parameters from.
type: str
required: true
cpm_username:
description:
- This is the Username of the WTI device to get the parameters from.
type: str
required: true
cpm_password:
description:
- This is the Password of the WTI device to get the parameters from.
type: str
required: true
cpm_path:
description:
- This is the directory path to store the WTI device configuration file.
type: str
required: false
default: "/tmp/"
use_https:
description:
- Designates to use an https connection or http connection.
type: bool
required: false
default: true
validate_certs:
description:
- If false, SSL certificates will not be validated. This should only be used
- on personally controlled sites using self-signed certificates.
type: bool
required: false
default: true
use_proxy:
description: Flag to control if the lookup will observe HTTP proxy environment variables when present.
type: bool
required: false
default: false
notes:
- Use C(groups/cpm) in C(module_defaults) to set common options used between CPM modules.)
"""
EXAMPLES = """
- name: Get the Parameters for a WTI device
cpm_config_backup:
cpm_url: "nonexist.wti.com"
cpm_username: "super"
cpm_password: "super"
use_https: true
validate_certs: false
"""
RETURN = """
data:
description: The XML configuration of the WTI device queried
returned: always
type: complex
contains:
status:
description: List of status returns from backup operation
returned: success
type: list
sample:
- code: 0
savedfilename: "/tmp/wti-192-10-10-239-2020-02-13T16-05-57.xml"
text: "ok"
"""
import base64
import json
import datetime
from ansible.module_utils.basic import AnsibleModule
from ansible.module_utils._text import to_text, to_bytes, to_native
from ansible.module_utils.six.moves.urllib.error import HTTPError, URLError
from ansible.module_utils.urls import open_url, ConnectionError, SSLValidationError
def get_unit_type(filedata):
beginsearch = filedata.find("unit_type_info=\"")
beginsearch = (beginsearch + 16)
endsearch = filedata.find("\">", beginsearch)
if (((endsearch == -1) | (beginsearch == -1)) | (endsearch < beginsearch) | ((endsearch - beginsearch) > 16)):
header = "wti"
else:
header = filedata[beginsearch:beginsearch + (endsearch - beginsearch)]
return (header)
def normalize_string(filedata):
filedata = filedata.replace(":", "-")
filedata = filedata.replace(".", "-")
return (filedata)
def run_module():
# define the available arguments/parameters that a user can pass to
# the module
module_args = dict(
cpm_url=dict(type='str', required=True),
cpm_username=dict(type='str', required=True),
cpm_password=dict(type='str', required=True, no_log=True),
cpm_path=dict(type='str', default="/tmp/"),
use_https=dict(type='bool', default=True),
validate_certs=dict(type='bool', default=True),
use_proxy=dict(type='bool', default=False)
)
result = dict(
changed=False,
data=''
)
module = AnsibleModule(argument_spec=module_args, supports_check_mode=True)
auth = to_text(base64.b64encode(to_bytes('{0}:{1}'.format(to_native(module.params['cpm_username']), to_native(module.params['cpm_password'])),
errors='surrogate_or_strict')))
if module.params['use_https'] is True:
protocol = "https://"
else:
protocol = "http://"
fullurl = ("%s%s/cgi-bin/gethtml?formWTIDownloadConfigXML.html" % (protocol, to_native(module.params['cpm_url'])))
try:
response = open_url(fullurl, data=None, method='GET', validate_certs=module.params['validate_certs'], use_proxy=module.params['use_proxy'],
headers={'Content-Type': 'application/xml', 'Authorization': "Basic %s" % auth})
except HTTPError as e:
fail_json = dict(msg='GET: Received HTTP error for {0} : {1}'.format(fullurl, to_native(e)), changed=False)
module.fail_json(**fail_json)
except URLError as e:
fail_json = dict(msg='GET: Failed lookup url for {0} : {1}'.format(fullurl, to_native(e)), changed=False)
module.fail_json(**fail_json)
except SSLValidationError as e:
fail_json = dict(msg='GET: Error validating the server''s certificate for {0} : {1}'.format(fullurl, to_native(e)), changed=False)
module.fail_json(**fail_json)
except ConnectionError as e:
fail_json = dict(msg='GET: Error connecting to {0} : {1}'.format(fullurl, to_native(e)), changed=False)
module.fail_json(**fail_json)
json_string = response.read()
try:
f = open(normalize_string(to_native(module.params['cpm_path'])) + get_unit_type(to_native(json_string)) + "-" + to_native(module.params['cpm_url']) +
"-" + datetime.datetime.now().replace(microsecond=0).isoformat() + ".xml", "wb")
f.write(json_string)
f.close()
json_string = '{\"status\": { \"code\": \"0\", \"text\": \"ok\", \"savedfilename\": \"%s%s-%s-%s.xml\" }}' \
% (normalize_string(to_native(module.params['cpm_path'])), get_unit_type(to_native(json_string)),
to_native(module.params['cpm_url']), datetime.datetime.now().replace(microsecond=0).isoformat())
except Exception as e:
json_string = "{\"status\": { \"code\": \"1\", \"text\": \"error: " + str(e) + "\", \"savedfilename\": \"\" }}"
result['data'] = json_string
module.exit_json(**result)
def main():
run_module()
if __name__ == '__main__':
main()
|
