| 1 |
#!/usr/bin/python |
| 2 |
|
| 3 |
# (c) 2020-2025, NetApp Inc. |
| 4 |
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) |
| 5 |
|
| 6 |
from __future__ import absolute_import, division, print_function |
| 7 |
|
| 8 |
__metaclass__ = type |
| 9 |
|
| 10 |
DOCUMENTATION = ''' |
| 11 |
module: na_ontap_active_directory |
| 12 |
author: NetApp Ansible Team (@carchi8py) <[email protected]> |
| 13 |
short_description: NetApp ONTAP configure active directory |
| 14 |
extends_documentation_fragment: |
| 15 |
- netapp.ontap.netapp.na_ontap |
| 16 |
version_added: 20.9.0 |
| 17 |
description: |
| 18 |
- Configure Active Directory. |
| 19 |
- REST requires ONTAP 9.12.1 or later. |
| 20 |
options: |
| 21 |
state: |
| 22 |
description: |
| 23 |
- Whether the Active Directory should exist or not |
| 24 |
choices: ['present', 'absent'] |
| 25 |
default: present |
| 26 |
type: str |
| 27 |
|
| 28 |
vserver: |
| 29 |
description: |
| 30 |
- The name of the vserver to use. |
| 31 |
required: true |
| 32 |
type: str |
| 33 |
|
| 34 |
account_name: |
| 35 |
description: |
| 36 |
- Active Directory account NetBIOS name. |
| 37 |
- Modifying an existing account name is not supported. The account must be deleted and recreated. |
| 38 |
required: true |
| 39 |
type: str |
| 40 |
|
| 41 |
admin_password: |
| 42 |
description: |
| 43 |
- Administrator password required for Active Directory account creation. |
| 44 |
required: true |
| 45 |
type: str |
| 46 |
|
| 47 |
admin_username: |
| 48 |
description: |
| 49 |
- Administrator username required for Active Directory account creation. |
| 50 |
required: true |
| 51 |
type: str |
| 52 |
|
| 53 |
domain: |
| 54 |
description: |
| 55 |
- Fully qualified domain name. |
| 56 |
type: str |
| 57 |
aliases: ['fqdn'] |
| 58 |
|
| 59 |
force_account_overwrite: |
| 60 |
description: |
| 61 |
- If true and a machine account with the same name as specified in 'account-name' exists in Active Directory, it will be overwritten and reused. |
| 62 |
type: bool |
| 63 |
|
| 64 |
organizational_unit: |
| 65 |
description: |
| 66 |
- Organizational unit under which the Active Directory account will be created. |
| 67 |
- Modifying the organizational unit is not supported. The object must be deleted and recreated. |
| 68 |
type: str |
| 69 |
|
| 70 |
notes: |
| 71 |
- Supports check_mode. |
| 72 |
- supports ZAPI and REST. REST requires ONTAP 9.12.1 or later. |
| 73 |
''' |
| 74 |
EXAMPLES = """ |
| 75 |
- name: Create active directory account. |
| 76 |
netapp.ontap.na_ontap_active_directory: |
| 77 |
hostname: "{{ netapp_hostname }}" |
| 78 |
username: "{{ netapp_username }}" |
| 79 |
password: "{{ netapp_password }}" |
| 80 |
https: true |
| 81 |
validate_certs: false |
| 82 |
vserver: laurentncluster-1 |
| 83 |
state: present |
| 84 |
account_name: carchi |
| 85 |
admin_password: password |
| 86 |
admin_username: carchi |
| 87 |
domain: addomain.com |
| 88 |
|
| 89 |
- name: Modify domain name. |
| 90 |
netapp.ontap.na_ontap_active_directory: |
| 91 |
hostname: "{{ netapp_hostname }}" |
| 92 |
username: "{{ netapp_username }}" |
| 93 |
password: "{{ netapp_password }}" |
| 94 |
https: true |
| 95 |
validate_certs: false |
| 96 |
vserver: laurentncluster-1 |
| 97 |
state: present |
| 98 |
account_name: carchi |
| 99 |
admin_password: password |
| 100 |
admin_username: carchi |
| 101 |
domain: addomain_new.com |
| 102 |
force_account_overwrite: true |
| 103 |
|
| 104 |
- name: Delete active directory account. |
| 105 |
netapp.ontap.na_ontap_active_directory: |
| 106 |
hostname: "{{ netapp_hostname }}" |
| 107 |
username: "{{ netapp_username }}" |
| 108 |
password: "{{ netapp_password }}" |
| 109 |
https: true |
| 110 |
validate_certs: false |
| 111 |
vserver: laurentncluster-1 |
| 112 |
state: absent |
| 113 |
account_name: carchi |
| 114 |
admin_password: password |
| 115 |
admin_username: carchi |
| 116 |
domain: addomain.com |
| 117 |
""" |
| 118 |
RETURN = """ |
| 119 |
|
| 120 |
""" |
| 121 |
|
| 122 |
import traceback |
| 123 |
|
| 124 |
from ansible.module_utils.basic import AnsibleModule |
| 125 |
from ansible.module_utils._text import to_native |
| 126 |
import ansible_collections.netapp.ontap.plugins.module_utils.netapp as netapp_utils |
| 127 |
from ansible_collections.netapp.ontap.plugins.module_utils.netapp_module import NetAppModule |
| 128 |
from ansible_collections.netapp.ontap.plugins.module_utils import rest_generic |
| 129 |
|
| 130 |
|
| 131 |
class NetAppOntapActiveDirectory: |
| 132 |
def __init__(self): |
| 133 |
self.argument_spec = netapp_utils.na_ontap_host_argument_spec() |
| 134 |
self.argument_spec.update(dict( |
| 135 |
vserver=dict(required=True, type='str'), |
| 136 |
state=dict(choices=['present', 'absent'], default='present'), |
| 137 |
account_name=dict(required=True, type='str'), |
| 138 |
admin_password=dict(required=True, type='str', no_log=True), |
| 139 |
admin_username=dict(required=True, type='str'), |
| 140 |
domain=dict(type="str", default=None, aliases=['fqdn']), |
| 141 |
force_account_overwrite=dict(type="bool", default=None), |
| 142 |
organizational_unit=dict(type="str", default=None) |
| 143 |
)) |
| 144 |
self.module = AnsibleModule( |
| 145 |
argument_spec=self.argument_spec, |
| 146 |
supports_check_mode=True |
| 147 |
) |
| 148 |
self.na_helper = NetAppModule() |
| 149 |
self.parameters = self.na_helper.set_parameters(self.module.params) |
| 150 |
self.rest_api = netapp_utils.OntapRestAPI(self.module) |
| 151 |
self.use_rest = self.rest_api.is_rest() |
| 152 |
self.svm_uuid = None |
| 153 |
|
| 154 |
if self.use_rest and not self.rest_api.meets_rest_minimum_version(self.use_rest, 9, 12, 1): |
| 155 |
msg = 'REST requires ONTAP 9.12.1 or later for active directory APIs' |
| 156 |
self.use_rest = self.na_helper.fall_back_to_zapi(self.module, msg, self.parameters) |
| 157 |
if not self.use_rest: |
| 158 |
if not netapp_utils.has_netapp_lib(): |
| 159 |
self.module.fail_json(msg=netapp_utils.netapp_lib_is_required()) |
| 160 |
self.server = netapp_utils.setup_na_ontap_zapi(module=self.module, vserver=self.parameters['vserver']) |
| 161 |
|
| 162 |
def get_active_directory(self): |
| 163 |
if self.use_rest: |
| 164 |
return self.get_active_directory_rest() |
| 165 |
active_directory_iter = netapp_utils.zapi.NaElement('active-directory-account-get-iter') |
| 166 |
active_directory_info = netapp_utils.zapi.NaElement('active-directory-account-config') |
| 167 |
active_directory_info.add_new_child('vserver', self.parameters['vserver']) |
| 168 |
query = netapp_utils.zapi.NaElement('query') |
| 169 |
query.add_child_elem(active_directory_info) |
| 170 |
active_directory_iter.add_child_elem(query) |
| 171 |
try: |
| 172 |
result = self.server.invoke_successfully(active_directory_iter, True) |
| 173 |
except netapp_utils.zapi.NaApiError as error: |
| 174 |
self.module.fail_json(msg='Error searching for Active Directory %s: %s' % |
| 175 |
(self.parameters['account_name'], to_native(error)), |
| 176 |
exception=traceback.format_exc()) |
| 177 |
record = {} |
| 178 |
if result.get_child_by_name('num-records') and int(result.get_child_content('num-records')) >= 1: |
| 179 |
account_info = result.get_child_by_name('attributes-list').get_child_by_name('active-directory-account-config') |
| 180 |
for zapi_key, key in (('account-name', 'account_name'), ('domain', 'domain'), ('organizational-unit', 'organizational_unit')): |
| 181 |
value = account_info.get_child_content(zapi_key) |
| 182 |
if value is not None: |
| 183 |
record[key] = value |
| 184 |
# normalize case, using user inputs |
| 185 |
for key, value in record.items(): |
| 186 |
if key in self.parameters and self.parameters[key].lower() == value.lower(): |
| 187 |
record[key] = self.parameters[key] |
| 188 |
return record or None |
| 189 |
|
| 190 |
def create_active_directory(self): |
| 191 |
if self.use_rest: |
| 192 |
return self.create_active_directory_rest() |
| 193 |
active_directory_obj = netapp_utils.zapi.NaElement('active-directory-account-create') |
| 194 |
active_directory_obj.add_new_child('account-name', self.parameters['account_name']) |
| 195 |
active_directory_obj.add_new_child('admin-password', self.parameters['admin_password']) |
| 196 |
active_directory_obj.add_new_child('admin-username', self.parameters['admin_username']) |
| 197 |
if self.parameters.get('domain'): |
| 198 |
active_directory_obj.add_new_child('domain', self.parameters['domain']) |
| 199 |
if self.parameters.get('force_account_overwrite'): |
| 200 |
active_directory_obj.add_new_child('force-account-overwrite', str(self.parameters['force_account_overwrite'])) |
| 201 |
if self.parameters.get('organizational_unit'): |
| 202 |
active_directory_obj.add_new_child('organizational-unit', self.parameters['organizational_unit']) |
| 203 |
try: |
| 204 |
self.server.invoke_successfully(active_directory_obj, True) |
| 205 |
except netapp_utils.zapi.NaApiError as error: |
| 206 |
self.module.fail_json(msg='Error creating vserver Active Directory %s: %s' % |
| 207 |
(self.parameters['account_name'], to_native(error))) |
| 208 |
|
| 209 |
def delete_active_directory(self): |
| 210 |
if self.use_rest: |
| 211 |
return self.delete_active_directory_rest() |
| 212 |
active_directory_obj = netapp_utils.zapi.NaElement('active-directory-account-delete') |
| 213 |
active_directory_obj.add_new_child('admin-password', self.parameters['admin_password']) |
| 214 |
active_directory_obj.add_new_child('admin-username', self.parameters['admin_username']) |
| 215 |
try: |
| 216 |
self.server.invoke_successfully(active_directory_obj, True) |
| 217 |
except netapp_utils.zapi.NaApiError as error: |
| 218 |
self.module.fail_json(msg='Error deleting vserver Active Directory %s: %s' % |
| 219 |
(self.parameters['account_name'], to_native(error))) |
| 220 |
|
| 221 |
def modify_active_directory(self): |
| 222 |
if self.use_rest: |
| 223 |
return self.modify_active_directory_rest() |
| 224 |
active_directory_obj = netapp_utils.zapi.NaElement('active-directory-account-modify') |
| 225 |
active_directory_obj.add_new_child('admin-password', self.parameters['admin_password']) |
| 226 |
active_directory_obj.add_new_child('admin-username', self.parameters['admin_username']) |
| 227 |
if self.parameters.get('domain'): |
| 228 |
active_directory_obj.add_new_child('domain', self.parameters['domain']) |
| 229 |
if self.parameters.get('force_account_overwrite'): |
| 230 |
active_directory_obj.add_new_child('force-account-overwrite', str(self.parameters['force_account_overwrite'])) |
| 231 |
try: |
| 232 |
self.server.invoke_successfully(active_directory_obj, True) |
| 233 |
except netapp_utils.zapi.NaApiError as error: |
| 234 |
self.module.fail_json(msg='Error modifying vserver Active Directory %s: %s' % |
| 235 |
(self.parameters['account_name'], to_native(error))) |
| 236 |
|
| 237 |
def get_active_directory_rest(self): |
| 238 |
api = 'protocols/active-directory' |
| 239 |
query = { |
| 240 |
'svm.name': self.parameters['vserver'], |
| 241 |
'fields': 'fqdn,name,organizational_unit' |
| 242 |
} |
| 243 |
record, error = rest_generic.get_one_record(self.rest_api, api, query) |
| 244 |
if error: |
| 245 |
self.module.fail_json(msg='Error searching for Active Directory %s: %s' % (self.parameters['account_name'], to_native(error)), |
| 246 |
exception=traceback.format_exc()) |
| 247 |
if record: |
| 248 |
self.svm_uuid = record['svm']['uuid'] |
| 249 |
return { |
| 250 |
'account_name': record.get('name'), |
| 251 |
'domain': record.get('fqdn'), |
| 252 |
'organizational_unit': record.get('organizational_unit') |
| 253 |
} |
| 254 |
return None |
| 255 |
|
| 256 |
def create_active_directory_rest(self): |
| 257 |
api = 'protocols/active-directory' |
| 258 |
body = { |
| 259 |
'svm.name': self.parameters['vserver'], |
| 260 |
'name': self.parameters['account_name'], |
| 261 |
'username': self.parameters['admin_username'], |
| 262 |
'password': self.parameters['admin_password'] |
| 263 |
} |
| 264 |
if self.parameters.get('domain'): |
| 265 |
body['fqdn'] = self.parameters['domain'] |
| 266 |
if self.parameters.get('force_account_overwrite'): |
| 267 |
body['force_account_overwrite'] = self.parameters['force_account_overwrite'] |
| 268 |
if self.parameters.get('organizational_unit'): |
| 269 |
body['organizational_unit'] = self.parameters['organizational_unit'] |
| 270 |
dummy, error = rest_generic.post_async(self.rest_api, api, body) |
| 271 |
if error: |
| 272 |
self.module.fail_json(msg='Error creating vserver Active Directory %s: %s' % (self.parameters['account_name'], to_native(error)), |
| 273 |
exception=traceback.format_exc()) |
| 274 |
|
| 275 |
def modify_active_directory_rest(self): |
| 276 |
api = 'protocols/active-directory' |
| 277 |
body = {'username': self.parameters['admin_username'], 'password': self.parameters['admin_password']} |
| 278 |
if self.parameters.get('domain'): |
| 279 |
body['fqdn'] = self.parameters['domain'] |
| 280 |
if self.parameters.get('force_account_overwrite'): |
| 281 |
body['force_account_overwrite'] = self.parameters['force_account_overwrite'] |
| 282 |
dummy, error = rest_generic.patch_async(self.rest_api, api, self.svm_uuid, body) |
| 283 |
if error: |
| 284 |
self.module.fail_json(msg='Error modifying vserver Active Directory %s: %s' % (self.parameters['account_name'], to_native(error)), |
| 285 |
exception=traceback.format_exc()) |
| 286 |
|
| 287 |
def delete_active_directory_rest(self): |
| 288 |
dummy, error = rest_generic.delete_async(self.rest_api, 'protocols/active-directory', self.svm_uuid, |
| 289 |
body={'username': self.parameters['admin_username'], 'password': self.parameters['admin_password']}) |
| 290 |
if error: |
| 291 |
self.module.fail_json(msg='Error deleting vserver Active Directory %s: %s' % (self.parameters['account_name'], to_native(error)), |
| 292 |
exception=traceback.format_exc()) |
| 293 |
|
| 294 |
def apply(self): |
| 295 |
current = self.get_active_directory() |
| 296 |
cd_action = self.na_helper.get_cd_action(current, self.parameters) |
| 297 |
modify = None |
| 298 |
if cd_action is None and self.parameters['state'] == 'present': |
| 299 |
modify = self.na_helper.get_modified_attributes(current, self.parameters) |
| 300 |
if modify and 'organizational_unit' in modify: |
| 301 |
self.module.fail_json(msg='Error: organizational_unit cannot be modified; found %s.' % modify) |
| 302 |
if modify and 'account_name' in modify: |
| 303 |
self.module.fail_json(msg='Error: account_name cannot be modified; found %s.' % modify) |
| 304 |
if self.na_helper.changed and not self.module.check_mode: |
| 305 |
if cd_action == 'create': |
| 306 |
self.create_active_directory() |
| 307 |
elif cd_action == 'delete': |
| 308 |
self.delete_active_directory() |
| 309 |
elif modify: |
| 310 |
self.modify_active_directory() |
| 311 |
result = netapp_utils.generate_result(self.na_helper.changed, cd_action, modify) |
| 312 |
self.module.exit_json(**result) |
| 313 |
|
| 314 |
|
| 315 |
def main(): |
| 316 |
""" |
| 317 |
Execute action from playbook |
| 318 |
""" |
| 319 |
command = NetAppOntapActiveDirectory() |
| 320 |
command.apply() |
| 321 |
|
| 322 |
|
| 323 |
if __name__ == '__main__': |
| 324 |
main() |