Vh OdZddlmZmZmZeZdZdZdZ ddl m Z ddl m Z e jdZd ZGd d eZd Zd ZdZdZedk(reyy)z/Ansible module for managing NFS server on Unity)absolute_importdivisionprint_functiona% module: nfsserver version_added: '1.4.0' short_description: Manage NFS server on Unity storage system description: - Managing the NFS server on the Unity storage system includes creating NFS server, getting NFS server details and deleting NFS server attributes. extends_documentation_fragment: - dellemc.unity.unity author: - Meenakshi Dembi (@dembim) options: nas_server_name: description: - Name of the NAS server on which NFS server will be hosted. type: str nas_server_id: description: - ID of the NAS server on which NFS server will be hosted. type: str nfs_server_id: description: - ID of the NFS server. type: str host_name: description: - Host name of the NFS server. type: str nfs_v4_enabled: description: - Indicates whether the NFSv4 is enabled on the NAS server. type: bool is_secure_enabled: description: - Indicates whether the secure NFS is enabled. type: bool kerberos_domain_controller_type: description: - Type of Kerberos Domain Controller used for secure NFS service. choices: [CUSTOM, UNIX, WINDOWS] type: str kerberos_domain_controller_username: description: - Kerberos Domain Controller administrator username. type: str kerberos_domain_controller_password: description: - Kerberos Domain Controller administrator password. type: str is_extended_credentials_enabled: description: - Indicates whether support for more than 16 unix groups in a Unix credential. type: bool remove_spn_from_kerberos: description: - Indicates whether to remove the SPN from Kerberos Domain Controller. default: true type: bool state: description: - Define whether the NFS server should exist or not. choices: [absent, present] required: true type: str notes: - The I(check_mode) is supported. - Modify operation for NFS Server is not supported. - When I(kerberos_domain_controller_type) is C(UNIX), I(kdc_type) in I(nfs_server_details) output is displayed as C(null). a` - name: Create NFS server with kdctype as Windows dellemc.unity.nfsserver: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" nas_server_name: "dummy_nas" host_name: "dummy_nas23" is_secure_enabled: true kerberos_domain_controller_type: "WINDOWS" kerberos_domain_controller_username: "administrator" kerberos_domain_controller_password: "Password123!" is_extended_credentials_enabled: true nfs_v4_enabled: true state: "present" - name: Create NFS server with kdctype as Unix dellemc.unity.nfsserver: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" nas_server_name: "dummy_nas" host_name: "dummy_nas23" is_secure_enabled: true kerberos_domain_controller_type: "UNIX" is_extended_credentials_enabled: true nfs_v4_enabled: true state: "present" - name: Get NFS server details dellemc.unity.nfsserver: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" nas_server_name: "dummy_nas" state: "present" - name: Delete NFS server dellemc.unity.nfsserver: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" nas_server_name: "dummy_nas" kerberos_domain_controller_username: "administrator" kerberos_domain_controller_password: "Password123!" unjoin_server_account: false state: "absent" a changed: description: Whether or not the resource has changed. returned: always type: bool sample: true nfs_server_details: description: Details of the NFS server. returned: When NFS server exists type: dict contains: credentials_cache_ttl: description: Credential cache refresh timeout. Resolution is in minutes. Default value is 15 minutes. type: str existed: description: Indicates if NFS Server exists. type: bool host_name: description: Host name of the NFS server. type: str id: description: Unique identifier of the NFS Server instance. type: str is_extended_credentials_enabled: description: Indicates whether the NFS server supports more than 16 Unix groups in a Unix credential. type: bool is_secure_enabled: description: Indicates whether secure NFS is enabled on the NFS server. type: bool kdc_type: description: Type of Kerberos Domain Controller used for secure NFS service. type: str nfs_v4_enabled: description: Indicates whether NFSv4 is enabled on the NAS server. type: bool servicee_principal_name: description: The Service Principal Name (SPN) for the NFS Server. type: str sample: { "credentials_cache_ttl": "0:15:00", "existed": true, "file_interfaces": { "UnityFileInterfaceList": [ { "UnityFileInterface": { "hash": 8778980109421, "id": "if_37" } } ] }, "hash": 8778980109388, "host_name": "dummy_nas23.pie.lab.emc.com", "id": "nfs_51", "is_extended_credentials_enabled": true, "is_secure_enabled": true, "kdc_type": "KdcTypeEnum.WINDOWS", "nas_server": { "UnityNasServer": { "hash": 8778980109412 } }, "nfs_v4_enabled": true, "servicee_principal_name": null } ) AnsibleModule)utils nfsserverz Ansible/1.7.1cReZdZdZdZd dZdZd dZdZdZ dd Z d Z d Z y) NFSServerz Class with NFS server operationsctj|_|jjt ddgg}gdg}t |jd|||_tj|j tj|j jt|_ tjd|j jy)z-Define all parameters required by this modulenas_server_name nas_server_id) nfs_server_idr r T) argument_specsupports_check_modemutually_exclusiverequired_one_ofzCheck Mode Flag %sN)r$get_unity_management_host_parameters module_paramsupdateget_nfs_server_parametersrmoduleensure_required_libsget_unity_unisphere_connectionparamsapplication_type unity_connLOGinfo check_mode)selfrrs k/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/dellemc/unity/plugins/modules/nfsserver.py__init__zNFSServer.__init__s"GGI !!";"=>0/BCPQ$,, $1+   ""4;;/>> KK   02 %t{{'='=>Nctjd |r,|jj|}|j S|rD|jj|}t |dkDrt |j Syy#tj$r}|jdk(r4d}tj||jj|nPd jt|}tj||jj|Yd}~yYd}~yd}~wtj$r9}d jt|}tj|Yd}~yd}~wwxYw) zGet NFS server details. :param: nfs_server_id: The ID of the NFS server :param: nas_server_id: The name of the NAS server :return: Dict containing NFS server details if exists zGetting NFS server details_id) nas_serverrNiz(Incorrect username or password provided.msgz2Failed to get details of NFS Server with error {0})rrrget_nfs_server_get_propertieslen process_dictr HttpError http_statuserrorr fail_jsonformatstrUnityResourceNotFoundError)r rr nfs_server_detailser)err_msgs r!get_nfs_server_detailsz NFSServer.get_nfs_server_detailssD -. %)__%C%C %C%V")99;;%)__%C%C}%C%]")*Q.'(:(J(J(LMM   3}}#@ # %%#%.,,2F3q6N '" %%'%22 /// ((.s1v  IIg   s+-B AB FBD77F /FFc |jj|}|S#t$rL}d|dt|}tj ||j j|Yd}~yd}~wwxYw)zGet NFS server instance. :param: nfs_server_id: The ID of the NFS server :return: Return NFS server instance if exists r%zFailed to get the NFS server z instance with error r(N)rr* Exceptionr3rr0rr1)r rnfs_server_objr6 error_msgs r!get_nfs_server_instancez!NFSServer.get_nfs_server_instancesi  1!__;; ;NN! ! 1,93q6CI IIi KK ! !i ! 0 0  1s A5AA00A5cXtjd |jjs&|j |}|j |||y#t $rL}d|dt|}tj||jj|Yd}~yd}~wwxYw) aqDelete NFS server. :param: nfs_server_id: The ID of the NFS server :param: skip_unjoin: Flag indicating whether to unjoin SMB server account from AD before deletion :param: domain_username: The domain username :param: domain_password: The domain password :return: Return True if NFS server is deleted zDeleting NFS server)r)skip_kdc_unjoinusernamepasswordTzFailed to delete NFS server: with error: r(N) rrrrr=deleter:r3r0r1)r r skip_unjoindomain_usernamedomain_passwordnfs_objr6r)s r!delete_nfs_serverzNFSServer.delete_nfs_servers &' +;;))66]6S{__no +FSUXYZU[\C IIcN KK ! !c ! * * +s># # +N]_bcd_efC IIcN KK ! !c ! * * +s+A B ABBcFtjd| ||dk7ryyy)a@Check if modification is required in existing NFS server :param: is_extended_credentials_enabled: Indicates whether the NFS server supports more than 16 Unix groups in a Unix credential. :param: nfs_server_details: NFS server details :return: True if modification is required z(Checking if any modification is requiredNis_extended_credentials_enabledT)rr)r rPr5s r!is_modification_requiredz"NFSServer.is_modification_requiredBs4 ;< * 6/3EFg3hhi 7r#c tjd |jjsPt |} |dk(rd}d}t j j|jj||||| ||| y#t$rL} d|dt| } tj| |jj| Yd} ~ yd} ~ wwxYw) aCreate NFS server. :param: nas_server_id: The ID of NAS server. :param: host_name: Name of NFS Server. :param: nfs_v4_enabled: Indicates whether the NFSv4 is enabled on the NAS server. :param: is_secure_enabled: Indicates whether the secure NFS is enabled. :param: kerberos_domain_controller_type: Type of Kerberos Domain Controller used for secure NFS service. :param: kerberos_domain_controller_username: Kerberos Domain Controller administrator username. :param: kerberos_domain_controller_password: Kerberos Domain Controller administrator password. :param: is_extended_credentials_enabled: Indicates whether support for more than 16 unix groups in a Unix credential. zCreating NFS serverUNIXN) clir' host_namenfs_v4_enabledis_secure_enabledkdc_type kdc_username kdc_passwordrPTz/Failed to create NFS server with on NAS Server rBr()rrrrget_enum_kdctyperUnityNfsServercreater_clir:r3r0r1) r r rUrVrWkerberos_domain_controller_type#kerberos_domain_controller_username#kerberos_domain_controller_passwordrP kdc_enum_typer6r)s r!create_nfs_serverzNFSServer.create_nfs_serverOs &' +;;)) 01P Q 2f<6:3(,%$$++0D0DQ^js;I>OZg9\9\Lk ,m  +XegjklgmnC IIcN KK ! !c ! * * +sA&A>> CACCcgd}|D]}d|z}|jj|"t|jj|jdk(sV|j |}|jj |y)N)rr r rUr`raz"Please provide valid value for: %srr()rrr,stripr2r1)r param_listparamr)errmsgs r!validate_input_paramszNFSServer.validate_input_paramsps=   2E6>C{{!!%(4T[[=O=OPU=V=\=\=^9_cd9dE* %%&%1  2r#c |jjd}|jjd}|jjd}|jjd}|jjd}|jjd}|jjd}|jjd}|jjd } |jjd } |jjd } |jjd } td i} d }|j|r|j |}|j ||}|r5| dk(r0|j | |}|r|jjd|s>| dk(r9|s|jjd|j||||||| | | d<| dk(r|r| }|j|d||| | d<| dk(r|j ||| d<|jjdi| y)zs Perform different actions on NFS server module based on parameters passed in the playbook rr r rUrVrWr_r`rarPremove_spn_from_kerberosstateF)changedr5)rr presentzMModification of NFS Server parameters is not supported through Ansible moduler(z7Please provide nas server id/name to create NFS server.rmabsentidr5N) rrdictrirNr8rQr1rcrH exit_json)r rr r rUrVrWr_r`rarPrkrlresult modify_flagr5rDs r!perform_module_operationz"NFSServer.perform_module_operationzs^  **?;  **?; ++,,->?KK&&{3 ++,<= KK../BC*.++*<*<=^*_'.2kk.@.@Af.g+.2kk.@.@Af.g+*.++*<*<=^*_'#';;#5#56P#Q  ""7+!    ""$  22?CM!88}GT9V %9"4778WYklK %%*y%z!ey&8  %%*c%d $ 6 6}iQ_7HJi7Z7Z7V !XF9  H !366K $ 6 67I$7OQ\7Z7Z!\F9  I +/+F+FUbUb,G,dF' ( ''r#)NN)NNN)NNNNNNN) __name__ __module__ __qualname____doc__r"r8r=rHrNrQrcrirvrqr#r!r r sA*?*B 1+( + gkdhdh+B2;(r#r c2ttdtdtdtdtdgdtdtddtdtdtdtddtddd d g  S) zYThis method provide parameters required for the ansible NFS server module on Unityr3)typebool)rSWINDOWSCUSTOM)r|choicesT)r|no_log)defaultr|rnro)requiredr|r) rrUrVrWr_r`rar r rPrkrl)rrrqr#r!rrs &E"(F+(,%A^(_,0e,<,0eD,I%(&(,&(9!%d!@Duy(6KL  r#cTtj|rtj|}|Sy)zGetting correct enum values for kerberos_domain_controller_type :param: kerberos_domain_controller_type: Type of Kerberos Domain Controller used for secure NFS service. :return: enum value for kerberos_domain_controller_type. N)r KdcTypeEnum)r_s r!r[r[s0  89*/*;*;<[*\'..:r#cngd}|D]+}||vr|dk(rt||d||<!||d||<-|S)zProcess NFS server details. :param: nfs_server_details: Dict containing NFS server details :return: Processed dict containing NFS server details ) credentials_cache_ttlfile_interfacesrUrprXr'rWrPrVservicee_principal_namerr)r3)r5rfrgs r!r-r-sf bJE & &54K+K(+,>u,Ea,H(I u %(:5(A!(D u % E r#c8t}|jy)z`Create Unity NFS server object and perform action on it based on user input from playbookN)r rv)objs r!mainrs +C  "r#__main__N)rz __future__rrrr| __metaclass__ DOCUMENTATIONEXAMPLESRETURNansible.module_utils.basicrCansible_collections.dellemc.unity.plugins.module_utils.storage.dellr get_loggerrrobjectr rr[r-rrwrqr#r!rs 6@@ G R4 lA F5e{#"^(^(B&/  # zFr#