VhdZddlmZmZmZeZdZdZdZ ddl m Z ddl m Z e jdZd ZGd d eZd Zd Zedk(reyy)z/Ansible module for managing User Quota on Unity)absolute_importdivisionprint_functionac --- module: user_quota short_description: Manage user quota on the Unity storage system description: - Managing User Quota on the Unity storage system includes Create user quota, Get user quota, Modify user quota, Delete user quota, Create user quota for quota tree, Modify user quota for quota tree and Delete user quota for quota tree. version_added: '1.2.0' extends_documentation_fragment: - dellemc.unity.unity author: - Spandita Panigrahi (@panigs7) options: filesystem_name: description: - The name of the filesystem for which the user quota is created. - For creation of a user quota either I(filesystem_name) or I(filesystem_id) is required. type: str filesystem_id: description: - The ID of the filesystem for which the user quota is created. - For creation of a user quota either I(filesystem_id) or I(filesystem_name) is required. type: str nas_server_name: description: - The name of the NAS server in which the filesystem is created. - For creation of a user quota either I(nas_server_name) or I(nas_server_id) is required. type: str nas_server_id: description: - The ID of the NAS server in which the filesystem is created. - For creation of a user quota either I(filesystem_id) or I(filesystem_name) is required. type: str hard_limit: description: - Hard limitation for a user on the total space available. If exceeded, user cannot write data. - Value C(0) implies no limit. - One of the values of I(soft_limit) and I(hard_limit) can be C(0), however, both cannot be C(0) during creation or modification of user quota. type: int soft_limit: description: - Soft limitation for a user on the total space available. If exceeded, notification will be sent to the user for the grace period mentioned, beyond which the user cannot use space. - Value C(0) implies no limit. - Both I(soft_limit) and I(hard_limit) cannot be C(0) during creation or modification of user quota. type: int cap_unit: description: - Unit of I(soft_limit) and I(hard_limit) size. - It defaults to C(GB) if not specified. choices: ['MB', 'GB', 'TB'] type: str user_type: description: - Type of user creating a user quota. - Mandatory while creating or modifying user quota. choices: ['Unix', 'Windows'] type: str win_domain: description: - Fully qualified or short domain name for Windows user type. - Mandatory when I(user_type) is C(Windows). type: str user_name: description: - User name of the user quota when I(user_type) is C(Windows) or C(Unix). - Option I(user_name) must be specified along with I(win_domain) when I(user_type) is C(Windows). type: str uid: description: - User ID of the user quota. type: str user_quota_id: description: - User quota ID generated after creation of a user quota. type: str tree_quota_id: description: - The ID of the quota tree. - Either I(tree_quota_id) or I(path) to quota tree is required to create/modify/delete user quota for a quota tree. type: str path: description: - The path to the quota tree. - Either I(tree_quota_id) or I(path) to quota tree is required to create/modify/delete user quota for a quota tree. - Path must start with a forward slash '/'. type: str state: description: - The I(state) option is used to mention the existence of the user quota. type: str required: true choices: ['absent', 'present'] notes: - The I(check_mode) is not supported. a- - name: Get user quota details by user quota id dellemc.unity.user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" user_quota_id: "userquota_171798700679_0_123" state: "present" - name: Get user quota details by user quota uid/user name dellemc.unity.user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" filesystem_name: "fs_2171" nas_server_id: "nas_21" user_name: "test" state: "present" - name: Create user quota for a filesystem with filesystem id dellemc.unity.user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" filesystem_id: "fs_2171" hard_limit: 6 cap_unit: "TB" soft_limit: 5 uid: "111" state: "present" - name: Create user quota for a filesystem with filesystem name dellemc.unity.user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" filesystem_name: "Test_filesystem" nas_server_name: "lglad068" hard_limit: 6 cap_unit: "TB" soft_limit: 5 uid: "111" state: "present" - name: Modify user quota limit usage by user quota id dellemc.unity.user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" user_quota_id: "userquota_171798700679_0_123" hard_limit: 10 cap_unit: "TB" soft_limit: 8 state: "present" - name: Modify user quota by filesystem id and user quota uid/user_name dellemc.unity.user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" filesystem_id: "fs_2171" user_type: "Windows" win_domain: "prod" user_name: "sample" hard_limit: 12 cap_unit: "TB" soft_limit: 10 state: "present" - name: Delete user quota dellemc.unity.user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" filesystem_id: "fs_2171" win_domain: "prod" user_name: "sample" state: "absent" - name: Create user quota of a quota tree dellemc.unity.user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" tree_quota_id: "treequota_171798700679_4" user_type: "Windows" win_domain: "prod" user_name: "sample" soft_limit: 9 cap_unit: "TB" state: "present" - name: Create user quota of a quota tree by quota tree path dellemc.unity.user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" filesystem_id: "fs_2171" path: "/sample" user_type: "Unix" user_name: "test" hard_limit: 2 cap_unit: "TB" state: "present" - name: Modify user quota of a quota tree dellemc.unity.user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" tree_quota_id: "treequota_171798700679_4" user_type: "Windows" win_domain: "prod" user_name: "sample" soft_limit: 10 cap_unit: "TB" state: "present" - name: Modify user quota of a quota tree by quota tree path dellemc.unity.user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" filesystem_id: "fs_2171" path: "/sample" user_type: "Windows" win_domain: "prod" user_name: "sample" hard_limit: 12 cap_unit: "TB" state: "present" - name: Delete user quota of a quota tree by quota tree path dellemc.unity.user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" filesystem_id: "fs_2171" path: "/sample" win_domain: "prod" user_name: "sample" state: "absent" - name: Delete user quota of a quota tree by quota tree id dellemc.unity.user_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" tree_quota_id: "treequota_171798700679_4" win_domain: "prod" user_name: "sample" state: "absent" a changed: description: Whether or not the resource has changed. returned: always type: bool sample: true get_user_quota_details: description: Details of the user quota. returned: When user quota exists type: dict contains: filesystem: description: Filesystem details for which the user quota is created. type: dict contains: UnityFileSystem: description: Filesystem details for which the user quota is created. type: dict contains: id: description: ID of the filesystem for which the user quota is created. type: str name: description: Name of filesystem. type: str nas_server: description: Nasserver details where filesystem is created. type: dict contains: name: description: Name of nasserver. type: str id: description: ID of nasserver. type: str tree_quota: description: Quota tree details for which the user quota is created. type: dict contains: UnityTreeQuota: description: Quota tree details for which the user quota is created. type: dict contains: id: description: ID of the quota tree. type: str path: description: Path to quota tree. type: str gp_left: description: The grace period left after the soft limit for the user quota is exceeded. type: int hard_limit: description: Hard limitation for a user on the total space available. If exceeded, user cannot write data. type: int hard_ratio: description: The hard ratio is the ratio between the hard limit size of the user quota and the amount of storage actually consumed. type: str soft_limit: description: Soft limitation for a user on the total space available. If exceeded, notification will be sent to user for the grace period mentioned, beyond which user cannot use space. type: int soft_ratio: description: The soft ratio is the ratio between the soft limit size of the user quota and the amount of storage actually consumed. type: str id: description: User quota ID. type: str size_used: description: Size of used space in the filesystem by the user files. type: int state: description: State of the user quota. type: int uid: description: User ID of the user. type: int unix_name: description: Unix user name for this user quota's uid. type: str windows_names: description: Windows user name that maps to this quota's uid. type: str windows_sids: description: Windows SIDs that maps to this quota's uid type: str sample: { "existed": true, "filesystem": { "UnityFileSystem": { "hash": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER", "id": "fs_120", "name": "nfs-multiprotocol", "nas_server": { "id": "nas_1", "name": "lglad072" } } }, "gp_left": null, "hard_limit": "10.0 GB", "hard_ratio": null, "hash": 8752448438089, "id": "userquota_171798694698_0_60000", "size_used": 0, "soft_limit": "10.0 GB", "soft_ratio": null, "state": 0, "tree_quota": null, "uid": 60000, "unix_name": null, "windows_names": null, "windows_sids": null } ) AnsibleModule)utils user_quotaz Ansible/1.7.1cVeZdZdZdZdZdZdZdZdZ dd Z dd Z d Z d Z d Zy) UserQuotaz Class with User Quota operationsctj|_|jjt ddgddgddgddgddgddgg}d d ddgd fd d dgd fg}t |jd || |_tj|j tj|j jt|_ y)z-Define all parameters required by this module user_nameuid win_domainfilesystem_name filesystem_idnas_server_name nas_server_id user_quota_id user_typeWindowsFUnix) argument_specsupports_check_modemutually_exclusive required_ifN) r$get_unity_management_host_parameters module_paramsupdateget_user_quota_parametersrmoduleensure_required_libsget_unity_unisphere_connectionparamsapplication_type unity_conn)selfrrs l/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/dellemc/unity/plugins/modules/user_quota.py__init__zUserQuota.__init__s"GGI !!";"=>*E2UL4I0/B0/B*O<$o6 8 $Y{0KUS#Vk]EBD $,, %1# % ""4;;/>> KK   02cT|j|||sy|r|n |r|n|r|n|}|jj|||||}tt |D]O}||j d|d||j d|} tj| ||j cSy)a Check if user quota is present in filesystem. :param fs_id: ID of filesystem where user quota is searched. :param uid: UID of the user quota :param unix: Unix user name of user quota :param win_name: Windows user name of user quota :param user_quota_id: ID of the user quota :return: ID of user quota if it exists else None. N) filesystemid unix_name windows_namesr User quota z with id z is present in filesystem ) check_user_type_providedr$get_user_quotarangelen tree_quotar+LOGinfo) r%fs_idr unixwin_nameruser_name_or_uid_or_idall_user_quotarmsgs r&check_user_is_presentzUserQuota.check_user_is_presents,,XsDA)-x8 NQ" 775]BFV^ tree_quota_id path_or_idtree_quota_objr;errormsgs r&check_quota_tree_is_presentz%UserQuota.check_quota_tree_is_presents"T} 775t;H8J ~  "AOPQARAUAUW\]C HHSM!!$'' ';jHH IIh  KK ! !h ! /r(c|j|||sy|r|n |r|n|r|n|}|jj|||||}t|dkDr-d|d|d}tj ||dj Sy)a Check if user quota is present in quota tree. :param tree_quota_id: ID of quota tree where user quota is searched. :param uid: UID of user quota :param unix: Unix name of user quota :param win_name: Windows name of user quota :param user_quota_id: ID of the user quota :return: ID of user quota if it exists in quota tree else None. N)r3r r-r,r+rr.z is present in quota tree  )r/r$r0r2r4r5r+) r%rCr r7r8ruser_quota_nameuser_quota_objr;s r&check_user_quota_in_quota_treez(UserQuota.check_user_quota_in_quota_trees,,XsDA!$#$$=E* 77=zUser quota does not exist.r?z>Failed to display the details of user quota {0} with error {1}N)r$r0_get_propertiesexistedrconvert_size_with_unitintr*r^rr_r+r3r>r4rArrBrRrSrT)r%rrKuser_quota_detailsrFr[s r&,get_filesystem_user_quota_display_attributesz6UserQuota.get_filesystem_user_quota_display_attributesFs  0!__;;MJN!/!?!?!A ."8"838**3/A,/O+P4R"<038**3/A,/O+P4R"<0#--22#<01BCFK"<01BCJJ!N,E,E,P,P,U,U*8*C*C*N*N*Q*Q$STU",,&1166'|45EFvN*)7 (# %%(%3 0##)6.*;*;SV#D  IIh  KK ! !h ! / /  0sD$E'3E G$AF??GNc|r|n|} d}|rx|s3d}tj||jj||jj ||}|r$|j rtjd||S|rd|r|jj ||}n|jj |}|r%|j rtjd||Syyy#t$rM}d|d t|d }tj||jj|Yd}~yd}~wwxYw) z Get filesystem details. :param nas_server: Nas server object. :param name: Name of filesystem. :param id: ID of filesystem. :return: Object containing filesystem details if it exists. Nz-NAS Server is required to get the FileSystem.r?)r^r_z*Successfully got the filesystem object %s.)r+r_r+zFailed to get filesystem with error .) r4rArrBr$get_filesystemrbr5rRrT) r%r_r^r+ id_or_nameobj_fserr_msgr[ error_msgs r&rkzUserQuota.get_filesystemks-R4  1F!MGIIg&KK))g)677TCM8OfnnHHI#%!M!__'2*E"__;;r;BFfnnHHI#%!M-6  1%s1v/I IIi KK ! !i ! 0 0  1s A;C+A#C++ E4AD<<Ec|r|n|}d|z} |jj||}|r$|jrtj d||S|r$|jrtj d||Stj ||j j|y#t$rM}d|dt|d}tj ||j j|Yd}~yd}~wwxYw) z Get nas server details. :param name: Nas server name. :param id: Nas server ID. :return: Object containing nas server details if it exists. zFailed to get NAS server %s.)_idr^z*Successfully got the NAS server object %s.r?zFailed to get NAS server rirjN) r$get_nas_serverrbr4r5rArrBrRrT)r%r^r+r_roobj_nasr[s r&get_nas_server_objzUserQuota.get_nas_server_objsR4 3j@  1oo44$4GGE "E " )$ %%)%4 1%s1v/I IIi KK ! !i ! 0 0  1s%AB(%B(61B(( C>1AC99C>c||y|jj|j}||d}ntj||}||d}ntj||}|r|d|k(r<|d|k(r4yd}t j ||jj| |jj|||} t jd| ry y#t$rV} d j|t| } t j | |jj| Yd} ~ yd} ~ wwxYw) at Modify user quota of filesystem by its uid/username/user quota id. :param user_quota_id: ID of the user quota :param soft_limit: Soft limit :param hard_limit: Hard limit :param unit: Unit of soft limit and hard limit :return: Boolean value whether modify user quota operation is successful. NFrOrNzThe user quota does not exist.r?)rrNrOz Successfully modified user quotaTz+Modify user quota {0} failed with error {1})r$r0rarrPr4rArrBmodify_user_quotar5rRrSrT) r%rrOrNrUrKrXrYrorZr[rFs r&rvzUserQuota.modify_user_quotasN  *"477 FVVX  "0"> "'"6"6z4"H   "0"> "'"6"6z4"H  l+/BB"<04GG8I IIi KK ! !i ! 0 0!__>>]J]J]?_N HH7 8 0))/ s1v)F  IIh  KK ! !h ! / /  0s25C)) E2A EEc|||yy)zChecks if user type or uid is provided :param win_name: Windows name of user quota :param uid: UID of user quota :param unix_name: Unix name of user quotaFT)r%r8r r,s r&r/z"UserQuota.check_user_type_provideds   0Ar(c |jjd}|jjd}|jjd}|jjd}|jjd}|jjd}|jjd}|jjd}|jjd } |jjd } |jjd } |jjd } |jjd } |jjd}|jjd}d}d}d}d}d}d}d} tdddid}| s|r|d}| dk(r8|dk(r3d}tj ||jj || rHt j| r3d}tj ||jj ||rHt j|r3d}tj ||jj || s| r9|7|5|3d}tj ||jj ||s|r7|5|3d}tj ||jj | |t j|r|jj dn-|jds|jj d|||jj d| r9|7|5|3d}tj ||jj | |Dt j|r|jj d |j|!}nE|Ct j|r|jj d"|j|#} |Qt j|r|jj d$|j||%}|j}nu|st j|r|jj d&|j|#}|r|d}|j}n|jj d'| s| r"| s|r| |jj d(|r| |}|j}|t jd)k(r$| d*k(s| r|jj d+n7|t jd,k(r!| d-k(r|jj d. | rAt j| s| js|jj d/| r| d*k(r3| t j| r|jj d0| d-k(rg| t j| r|jj d1n3| t j| r|jj d0| d*k7r| r| j!d2d} | d3z| z}|| r| } |s|r|j#|||}|} |r|j%|| |||}|dn|}n|j'|| |||}|r|}|d4k(r]|r|j)|| |||d5<nCtj+d6|j-|| ||| |||}|r|j}d7|d8<nd} |d9k(r7|r5d} d}d:|z}tj+||j)|| |||d;< |d4k(r|r|j/|}||d<<|d8s |d5s|d;rd7|d=<|jj0d>i|y)?zs Perform different actions on user quota module based on parameters passed in the playbook rrrrcap_unitstaterrNrOrr r rrCr>NF)changedrQrvget_user_quota_detailsdelete_user_quotaGBrz2Both soft limit and hard limit cannot be unlimitedr?z3Invalid soft_limit provided, must be greater than 0z3Invalid hard_limit provided, must be greater than 0z6Please provide either filesystem_name or filesystem_idz Please provide a valid path./zXThe path is relative to the root of the file system and must start with a forward slash.z6Please provide either filesystem_name or fileystem_id.zPlease provide either filesystem_name or filesystem_id to create user quota for afilesystem. Or provide tree_quota_id to create user quota for a quota tree.z;Invalid nas_server_name given, Please provide a valid name.)r^z7Invalid nas_server_id given, Please provide a valid ID.rhz;Invalid filesystem_name given, Please provide a valid name.)r_r^z7Invalid filesystem_id given, Please provide a valid ID.zFilesystem does not exist.z:Invalid user_type given, Please provide a valid user_type.CIFSrzwThis filesystem supports only SMB protocol and applicable only for windows users. Please provide valid windows details.NFSrzxThis filesystem supports only NFS protocol and applicable only for unix users. Please provide valid uid or unix details.z( UID is empty. Please provide valid UID.z6 'user_name' is empty. Please provide valid user_name.z8 'win_domain' is empty. Please provide valid win_domain.z.com\presentrvzCreating user quotaTrQabsentzDeleting user quota %srr~r}rx)rr"dictr4rArBris_size_negativeis_input_empty startswithrtrkr+supported_protocolsFSSupportedProtocolEnum isnumericreplacerGrLr<rvr5rQrf exit_json)r%rrrrrzr{rrNrOrr r rrCr>create_user_quota_objr8r,nas_server_resourcer6refilesystem_objresult error_messagesupported_protocolquota_tree_id_presentuser_id_presentrns r&perform_module_operationz"UserQuota.perform_module_operations+  **?; ++,,->?++,,->? **?; ;;%%j1 ""7+ **?; [['' 5 [['' 5 KK&&{3 kk  'KK&&{3 [['' 5  **?; {{!!&) $ " ###%#   *(*:H ?zQPM IIm $ KK ! !m ! 4 %00<5M IIm $ KK ! !m ! 4 %00<5M IIm $ KK ! !m ! 4 -"7'M,A?M IIm $ KK ! !m ! 4 }"*/F?M IIm $ KK ! !m ! 4   ##D) %%*I%J__S) %%+Q%R$)@ %%*b%c .?3J}OdjM IIm $ KK ! !m ! 4   &##O4 %%+J%K"&###9  &##M2 %%+H%I"&"9"9]"9"K    &##O4 %%+J%K!+>%4 6 #%%E  &##M2 %%+H%I!=1 !/!2&)) %%*F%G * % KK ! !'K ! L z59O!/!C!C !U%B%B6%JJ"f, %%+R%S$u'D'DU'KK!Y. %%+V%W  E((-S]]_ KK ! !&P ! Q F"$(<(*>y*IKK)).f)g  :#++FB7J!D(94H   !I  D$($D$DUDR_$` !1M  "AA-QTV_aiBOQO)5D5E"88YPXZghO +M I .2.D.D]T^EOQY/[*+./(,(>(>ujR\?GiYa?L)N%)$9$<$G HHW *.*@*@AKZYa+cF& '  I -!%!R!RS`!a +='( % &&1D*EPcId $F9  ''r()NNN)NN)__name__ __module__ __qualname____doc__r'r<rGrLrQrfrkrtrvr/rrxr(r&r r sB*22B0*4'0R#0J$1L18-0^l(r(r cttddtddtddddgtdddd gtddtddtddtdd tdd tddgd tddtddtddtddtddd  S)zdThis method provide parameters required for the ansible filesystem user quota module on UnityFrT)requiredtypeTrr)rrchoicesrrrd)MBrTB)rrno_log)rrr{rr r rrNrOrzrrrrCr>)rrxr(r&rrs E6e%8Duy(6KLE )624E2 %e ,U3U3U3u5:LME6e%8E6E6 5uT :! r(c8t}|jy)zb Create Unity user quota object and perform action on it based on user input from playbookN)r r)objs r&mainrs +C  "r(__main__N)r __future__rrrr __metaclass__ DOCUMENTATIONEXAMPLESRETURNansible.module_utils.basicrCansible_collections.dellemc.unity.plugins.module_utils.storage.dellr get_loggerr4r#objectr rrrrxr(r&rs 6@@ o be NB H5e|$"a(a(H.# zFr(