Debian Codegraph @

ansible_collections/netapp/cloudmanager/plugins/modules/na_cloudmanager_cifs_server.py

raw
1 #!/usr/bin/python
2
3 # (c) 2021, NetApp, Inc
4 # GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
5
6 '''
7 na_cloudmanager_cifs_server
8 '''
9
10 from __future__ import absolute_import, division, print_function
11
12 __metaclass__ = type
13
14 DOCUMENTATION = '''
15
16 module: na_cloudmanager_cifs_server
17 short_description: NetApp Cloud Manager cifs server
18 extends_documentation_fragment:
19 - netapp.cloudmanager.netapp.cloudmanager
20 version_added: '21.3.0'
21 author: NetApp Ansible Team (@carchi8py) <[email protected]>
22
23 description:
24 - Create or Delete a CIFS server on the Cloud Volume ONTAP system to support CIFS volumes, based on an Active Directory or Workgroup.
25
26 options:
27 state:
28 description:
29 - Whether the specified cifs server should exist or not.
30 choices: ['present', 'absent']
31 default: 'present'
32 type: str
33
34 working_environment_name:
35 description:
36 - The working environment name where the cifs server will be created.
37 type: str
38
39 working_environment_id:
40 description:
41 - The public ID of the working environment where the cifs server will be created.
42 type: str
43
44 client_id:
45 description:
46 - The connector ID of the Cloud Manager Connector.
47 required: true
48 type: str
49
50 domain:
51 description:
52 - The active directory domain name. For CIFS AD only.
53 type: str
54
55 dns_domain:
56 description:
57 - The DNS domain name. For CIFS AD only.
58 type: str
59
60 username:
61 description:
62 - The active directory admin user name. For CIFS AD only.
63 type: str
64
65 password:
66 description:
67 - The active directory admin password. For CIFS AD only.
68 type: str
69
70 ip_addresses:
71 description:
72 - The DNS server IP addresses. For CIFS AD only.
73 type: list
74 elements: str
75
76 netbios:
77 description:
78 - The CIFS server NetBIOS name. For CIFS AD only.
79 type: str
80
81 organizational_unit:
82 description:
83 - The organizational unit in which to register the CIFS server. For CIFS AD only.
84 type: str
85
86 is_workgroup:
87 description:
88 - For CIFS workgroup operations, set to true.
89 type: bool
90
91 server_name:
92 description:
93 - The server name. For CIFS workgroup only.
94 type: str
95
96 workgroup_name:
97 description:
98 - The workgroup name. For CIFS workgroup only.
99 type: str
100
101 notes:
102 - Support check_mode.
103 '''
104
105 EXAMPLES = '''
106 - name: Create cifs server with working_environment_id
107 netapp.cloudmanager.na_cloudmanager_cifs_server:
108 state: present
109 working_environment_id: VsaWorkingEnvironment-abcdefgh
110 client_id: your_client_id
111 refresh_token: your_refresh_token
112 domain: example.com
113 username: admin
114 password: pass
115 dns_domain: example.com
116 ip_addresses: ["1.0.0.0"]
117 netbios: cvoname
118 organizational_unit: CN=Computers
119 '''
120
121 RETURN = r''' # '''
122
123 from ansible.module_utils.basic import AnsibleModule
124 import ansible_collections.netapp.cloudmanager.plugins.module_utils.netapp as netapp_utils
125 from ansible_collections.netapp.cloudmanager.plugins.module_utils.netapp_module import NetAppModule
126
127
128 class NetAppCloudmanagerCifsServer:
129
130 def __init__(self):
131 """
132 Parse arguments, setup state variables,
133 check parameters and ensure request module is installed
134 """
135 self.argument_spec = netapp_utils.cloudmanager_host_argument_spec()
136 self.argument_spec.update(dict(
137 state=dict(required=False, choices=['present', 'absent'], default='present'),
138 working_environment_id=dict(required=False, type='str'),
139 working_environment_name=dict(required=False, type='str'),
140 client_id=dict(required=True, type='str'),
141 domain=dict(required=False, type='str'),
142 dns_domain=dict(required=False, type='str'),
143 username=dict(required=False, type='str'),
144 password=dict(required=False, type='str', no_log=True),
145 ip_addresses=dict(required=False, type='list', elements='str'),
146 netbios=dict(required=False, type='str'),
147 organizational_unit=dict(required=False, type='str'),
148 is_workgroup=dict(required=False, type='bool'),
149 server_name=dict(required=False, type='str'),
150 workgroup_name=dict(required=False, type='str'),
151 ))
152 self.module = AnsibleModule(
153 argument_spec=self.argument_spec,
154 required_one_of=[
155 ['refresh_token', 'sa_client_id'],
156 ['working_environment_name', 'working_environment_id'],
157 ],
158 required_together=[['sa_client_id', 'sa_secret_key']],
159 mutually_exclusive=[
160 ('domain', 'server_name'),
161 ('dns_domain', 'server_name'),
162 ('username', 'server_name'),
163 ('password', 'server_name'),
164 ('ip_addresses', 'server_name'),
165 ('netbios', 'server_name'),
166 ('organizational_unit', 'server_name'),
167 ('domain', 'workgroup_name'),
168 ('dns_domain', 'workgroup_name'),
169 ('username', 'workgroup_name'),
170 ('password', 'workgroup_name'),
171 ('ip_addresses', 'workgroup_name'),
172 ('netbios', 'workgroup_name'),
173 ('organizational_unit', 'workgroup_name'),
174 ],
175 supports_check_mode=True
176 )
177 self.na_helper = NetAppModule()
178 # set up state variables
179 self.parameters = self.na_helper.set_parameters(self.module.params)
180 # Calling generic rest_api class
181 self.rest_api = netapp_utils.CloudManagerRestAPI(self.module)
182 self.rest_api.token_type, self.rest_api.token = self.rest_api.get_token()
183 self.rest_api.url += self.rest_api.environment_data['CLOUD_MANAGER_HOST']
184 self.headers = {
185 'X-Agent-Id': self.rest_api.format_client_id(self.parameters['client_id'])
186 }
187 if self.parameters.get('working_environment_id'):
188 working_environment_detail, error = self.na_helper.get_working_environment_details(self.rest_api, self.headers)
189 else:
190 working_environment_detail, error = self.na_helper.get_working_environment_details_by_name(self.rest_api,
191 self.headers,
192 self.parameters['working_environment_name'])
193 if working_environment_detail is not None:
194 self.parameters['working_environment_id'] = working_environment_detail['publicId']
195 else:
196 self.module.fail_json(msg="Error: Cannot find working environment: %s" % str(error))
197 self.na_helper.set_api_root_path(working_environment_detail, self.rest_api)
198
199 def get_cifs_server(self):
200 response, err, dummy = self.rest_api.send_request("GET", "%s/working-environments/%s/cifs" % (
201 self.rest_api.api_root_path, self.parameters['working_environment_id']), None, header=self.headers)
202 if err is not None:
203 self.module.fail_json(changed=False, msg="Error on get_cifs_server: %s, %s" % (str(err), str(response)))
204 current_cifs = dict()
205 if response is None or len(response) == 0:
206 return None
207 # only one cifs server exists per working environment.
208 for server in response:
209 if server.get('activeDirectoryDomain'):
210 current_cifs['domain'] = server['activeDirectoryDomain']
211 if server.get('dnsDomain'):
212 current_cifs['dns_domain'] = server['dnsDomain']
213 if server.get('ipAddresses'):
214 current_cifs['ip_addresses'] = server['ipAddresses']
215 if server.get('organizationalUnit'):
216 current_cifs['organizational_unit'] = server['organizationalUnit']
217 if server.get('netBIOS'):
218 current_cifs['netbios'] = server['netBIOS']
219 return current_cifs
220
221 def create_cifs_server(self):
222 exclude_list = ['client_id', 'domain', 'netbios', 'username', 'password']
223 server = self.na_helper.convert_module_args_to_api(self.parameters, exclude_list)
224 if self.parameters.get('domain'):
225 server['activeDirectoryDomain'] = self.parameters['domain']
226 if self.parameters.get('netbios'):
227 server['netBIOS'] = self.parameters['netbios']
228 if self.parameters.get('username'):
229 server['activeDirectoryUsername'] = self.parameters['username']
230 if self.parameters.get('password'):
231 server['activeDirectoryPassword'] = self.parameters['password']
232 url = "%s/working-environments/%s/cifs" % (self.rest_api.api_root_path,
233 self.parameters['working_environment_id'])
234 if self.parameters.get('is_workgroup'):
235 url = url + "-workgroup"
236
237 response, err, dummy = self.rest_api.send_request("POST", url, None, server, header=self.headers)
238 if err is not None:
239 self.module.fail_json(changed=False, msg="Error on create_cifs_server failed: %s, %s" % (str(err), str(response)))
240
241 def delete_cifs_server(self):
242 response, err, dummy = self.rest_api.send_request("POST", "%s/working-environments/%s/delete-cifs" % (
243 self.rest_api.api_root_path, self.parameters['working_environment_id']), None, {}, header=self.headers)
244 if err is not None:
245 self.module.fail_json(changed=False, msg="Error on delete_cifs_server: %s, %s" % (str(err), str(response)))
246
247 def apply(self):
248 current = self.get_cifs_server()
249 cd_action = self.na_helper.get_cd_action(current, self.parameters)
250 if self.na_helper.changed and not self.module.check_mode:
251 if cd_action == 'create':
252 self.create_cifs_server()
253 elif cd_action == 'delete':
254 self.delete_cifs_server()
255 self.module.exit_json(changed=self.na_helper.changed)
256
257
258 def main():
259 '''Main Function'''
260 server = NetAppCloudmanagerCifsServer()
261 server.apply()
262
263
264 if __name__ == '__main__':
265 main()