VhhdZddlmZmZmZeZdZdZdZ ddl m Z ddl m Z e jdZd ZGd d eZd Zd Zedk(reyy)z/Ansible module for managing quota tree on Unity)absolute_importdivisionprint_functionao --- module: tree_quota short_description: Manage quota tree on the Unity storage system description: - Managing Quota tree on the Unity storage system includes Create quota tree, Get quota tree, Modify quota tree and Delete 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 quota tree is created. - For creation or modification of a quota tree either I(filesystem_name) or I(filesystem_id) is required. type: str filesystem_id: description: - The ID of the filesystem for which the quota tree is created. - For creation of a quota tree 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 quota tree 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 quota tree either I(filesystem_id) or I(filesystem_name) is required. 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 view/modify/delete 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/view/modify/delete a quota tree. - Path must start with a forward slash '/'. type: str hard_limit: description: - Hard limitation for a quota tree on the total space available. If exceeded, users in quota tree 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 both C(0) during creation of a quota tree. type: int soft_limit: description: - Soft limitation for a quota tree on the total space available. If exceeded, notification will be sent to users in the quota tree for the grace period mentioned, beyond which users cannot use space. - Value C(0) implies no limit. - Both I(soft_limit) and I(hard_limit) cannot be C(0) during creation of quota tree. 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 description: description: - Description of a quota tree. type: str state: description: - The state option is used to mention the existence of the filesystem quota tree. type: str required: true choices: ['absent', 'present'] notes: - The I(check_mode) is not supported. a; - name: Get quota tree details by quota tree id dellemc.unity.tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" tree_quota_id: "treequota_171798700679_10" state: "present" - name: Get quota tree details by quota tree path dellemc.unity.tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" filesystem_name: "fs_2171" nas_server_id: "nas_21" path: "/test" state: "present" - name: Create quota tree for a filesystem with filesystem id dellemc.unity.tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" filesystem_id: "fs_2171" hard_limit: 6 cap_unit: "TB" soft_limit: 5 path: "/test_new" state: "present" - name: Create quota tree for a filesystem with filesystem name dellemc.unity.tree_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 path: "/test_new" state: "present" - name: Modify quota tree limit usage by quota tree path dellemc.unity.tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" path: "/test_new" hard_limit: 10 cap_unit: "TB" soft_limit: 8 state: "present" - name: Modify quota tree by quota tree id dellemc.unity.tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" filesystem_id: "fs_2171" tree_quota_id: "treequota_171798700679_10" hard_limit: 12 cap_unit: "TB" soft_limit: 10 state: "present" - name: Delete quota tree by quota tree id dellemc.unity.tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" filesystem_id: "fs_2171" tree_quota_id: "treequota_171798700679_10" state: "absent" - name: Delete quota tree by path dellemc.unity.tree_quota: unispherehost: "{{unispherehost}}" username: "{{username}}" password: "{{password}}" validate_certs: "{{validate_certs}}" filesystem_id: "fs_2171" path: "/test_new" state: "absent" a changed: description: Whether or not the resource has changed. returned: always type: bool sample: true get_tree_quota_details: description: Details of the quota tree. returned: When quota tree exists type: dict contains: filesystem: description: Filesystem details for which the quota tree is created. type: dict contains: UnityFileSystem: description: Filesystem details for which the quota tree is created. type: dict contains: id: description: ID of the filesystem for which the quota tree is create. type: str description: description: Description of the quota tree. type: str path: description: Path to quota tree. A valid path must start with a forward slash '/'. It is mandatory while creating a quota tree. type: str hard_limit: description: Hard limit of quota tree. If the quota tree's space usage exceeds the hard limit, users in quota tree cannot write data. type: int soft_limit: description: Soft limit of the quota tree. If the quota tree's space usage exceeds the soft limit, the storage system starts to count down based on the specified grace period. type: int id: description: Quota tree ID. type: str size_used: description: Size of used space in the filesystem by the user files. type: int gp_left: description: The grace period left after the soft limit for the user quota is exceeded. type: int state: description: State of the quota tree. type: int sample: { "description": "", "existed": true, "filesystem": { "UnityFileSystem": { "hash": 8788549469862, "id": "fs_137", "name": "test", "nas_server": { "id": "nas_1", "name": "lglad072" } } }, "gp_left": null, "hard_limit": "6.0 TB", "hash": 8788549497558, "id": "treequota_171798694897_1", "path": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER", "size_used": 0, "soft_limit": "5.0 TB", "state": 0 } ) AnsibleModule)utils tree_quotaz Ansible/1.7.1cJeZdZdZdZdZdZdZd dZd dZ d Z d Z d Z y) QuotaTreez Class with Quota Tree operationscjtj|_|jjt ddgddgg}t |jd||_tj|j tj|j jt|_ y)z-Define all parameters required by this modulefilesystem_name filesystem_idnas_server_name nas_server_idF) argument_specsupports_check_modemutually_exclusiveN) r$get_unity_management_host_parameters module_paramsupdateget_quota_tree_parametersrmoduleensure_required_libsget_unity_unisphere_connectionparamsapplication_type unity_conn)selfrs l/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/dellemc/unity/plugins/modules/tree_quota.py__init__zQuotaTree.__init__$s"GGI !!";"=>0/B0/BD$,, %13  ""4;;/>> KK   02c||y|jj|||}|r`t|dk(rR|jjddk(r6d|z}t j ||jj|t|dkDr9d|djd |}t j||djSy) a1 Check if quota tree is present in filesystem. :param fs_id: ID of filesystem where quota tree is searched. :param path: Path to the quota tree :param tree_quota_id: ID of the quota tree :return: ID of quota tree if it exists else None. N) filesystemidpathrstatepresentzTree quota %s does not exist.msgzQuota tree with id z is present in filesystem ) rget_tree_quotalenrrLOGerror fail_jsonr#info)rfs_idr$ tree_quota_idall_tree_quotaerrormsgr(s rcheck_quota_tree_is_presentz%QuotaTree.check_quota_tree_is_present6s  T\775;H=A8C S0A5KK&&w/9<6FH IIh  KK ! !h ! / ~  "IWXYIZI]I]INPC HHSM!!$'' 'r c|5|3d}tj||jj|t j ||}t j ||} |j j|| |||} tjd| r| Sy#t$rW} dj||t| }tj||jj|Yd} ~ yd} ~ wwxYw)a Create quota tree of a filesystem. :param fs_id: ID of filesystem where quota tree is to be created. :param soft_limit: Soft limit :param hard_limit: Hard limit :param unit: Unit of soft limit and hard limit :param path: Path to quota tree :param description: Description for quota tree :return: Dict containing new quota tree details. Nz`Both soft limit and hard limit cannot be empty. Please provide atleast one to create quota tree.r')r hard_limit soft_limitr$ descriptionzSuccessfully created quota treezOCreate quota tree operation at path {0} failed in filesystem {1} with error {2}) r+r,rr-rget_size_bytesrcreate_tree_quotar. Exceptionformatstr) rr/r6r5unitr$r7r2soft_limit_in_byteshard_limit_in_bytesobj_tree_quotaes rcreate_quota_treezQuotaTree.create_quota_treeSs  *"4JH IIh  KK ! !h ! /#22:tD#22:tD 0!__>>U_rJ]dhKV?XN HH6 7%% 0))/eSV)D  IIh  KK ! !h ! / /  0s%8B C?(A C::C?c |jj|}|j}|r|jrt j t |d|d<t j t |d|d<|jj|ddd<|ddjd|jjj|jjjdi|Sy y #t$r`}d jjt|}tj!||j"j%| Yd }~y d }~wwxYw) zDisplay quota tree attributes :param tree_quota_id: Quota tree ID :return: Quota tree dict to display )_idr6r5r"UnityFileSystemname nas_server)rFr#z7Failed to display quota tree details {0} with error {1}r'N)rr)_get_propertiesexistedrconvert_size_with_unitintr"rFrrGr#r:r;r<r+r,rr-)rr0tree_quota_objtree_quota_detailsrAr2s r,get_filesystem_tree_quota_display_attributesz6QuotaTree.get_filesystem_tree_quota_display_attributesxs]  0!__;; ;NN!/!?!?!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*)#9~ 0##)6.*;*;SV#D  IIh  KK ! !h ! / /  0sC:C?? E(AE##E(Nc|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: Dict containing filesystem details if it exists. Nz-NAS Server is required to get the FileSystem.r')rFrGz*Successfully got the filesystem object %s.)r#rGr#zFailed to get filesystem with error .) r+r,rr-rget_filesystemrIr.r:r<) rrGrFr# id_or_nameobj_fserr_msgrA error_msgs rrSzQuotaTree.get_filesystems-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: Dict containing nas server details if it exists. zFailed to get NAS server %s.)rDrFz*Successfully got the NAS server object %s.r'zFailed to get NAS server rQrRN) rget_nas_serverrIr+r.r,rr-r:r<)rrFr#rGrWobj_nasrAs rget_nas_server_objzQuotaTree.get_nas_server_objsR4 3j@  1oo44$4GGE "E " )$ %%)%4 1%s1v/I IIi KK ! !i ! 0 0  1s%AB(%B(61B(( C>1AC99C>cR ||y|jj|j}||d}ntj||}||d}ntj||}||d}|rQ|d|k(r|d|k(r |d|k(ry|jj ||||} t jd| ryyy#t$rV} d j|t| } t j| |jj| Yd} ~ yd} ~ wwxYw) a Modify quota tree of filesystem. :param tree_quota_id: ID of the quota tree :param soft_limit: Soft limit :param hard_limit: Hard limit :param unit: Unit of soft limit and hard limit :param description: Description of quota tree :return: Boolean value whether modify quota tree operation is successful. NFr6r5r7)r0r5r6r7z Successfully modified quota treeTz5Modify quota tree operation {0} failed with error {1}r')rr)rHrr8modify_tree_quotar+r.r:r;r<r,rr-) rr0r6r5r=r7rLr>r?r]rAr2s rr]zQuotaTree.modify_tree_quotasP! 0!j&8!__;;MJZZ\N!&4\&B#&+&:&::t&L#!&4\&B#&+&:&::t&L#",]; !,/3FF&|48KK&}5D (,(I(IXeUhUhVa)J)c%HH?@(#) 0))/ s1v)F  IIh  KK ! !h ! / /  0s$CBC6C D&A D!!D&c |jj|}|ryy#t$rV}dj|t |}t j ||jj|Yd}~yd}~wwxYw)z Delete quota tree of a filesystem. :param tree_quota_id: ID of quota tree :return: Boolean whether quota tree is deleted )r0Tz;Delete operation of quota tree id:{0} failed with error {1}r'N) rdelete_tree_quotar:r;r<r+r,rr-)rr0delete_tree_quota_objrAr2s rr_zQuotaTree.delete_tree_quotas 0$(OO$E$ETa$E$b !$% 0//5vm69!f0>  IIh  KK ! !h ! / /  0s" BA A<<Bcl |jjd}|jjd}|jjd}|jjd}|jjd}|jjd}|jjd}|jjd}|jjd } |jjd } |jjd } d } d } d } td d d id }|s|r|d}|rHtj|r3d}t j ||jj||rHtj|r3d}t j ||jj| |Dtj|r|jjd|j|} nE|Ctj|r|jjd|j|} |Qtj|r|jjd|j| |}|j}ns|qtj|r|jjd|j|}|r|dj}n|jjd | tj| r|jjdn-| jds|jjd|||jjd|j|| | }|} |s|r4| 2|d k(r-| s+t jd!|j||||| | } | r| j} d"|d#< | r2|d k(r-t jd$|j!| |||| |d%< | .|d&k(r)t jd'|j#| |d(< |d k(r| |j%| |d)<ni|d)<|d#s |d%s|d(rd"|d*<|jj&d+i|y ),zs Perform different actions on quota tree module based on parameters passed in the playbook r r rrcap_unitr%r5r6r$r7r0NF)changedr9r]get_tree_quota_detailsr_GBz?Invalid soft_limit provided, must be greater than or equal to 0r'z?Invalid hard_limit provided, must be greater than or equal to 0z;Invalid nas_server_name given, Please provide a valid name.)rFz7Invalid nas_server_id given, Please provide a valid ID.rPz;Invalid filesystem_name given, Please provide a valid name.)rGrFz7Invalid filesystem_id given, Please provide a valid ID.rzFilesystem does not exist.z Please provide a valid path./z\The 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.r&zCreating quota treeTr9zModifying quota treer]absentzDeleting quota treer_rdrc)rrdictris_size_negativer+r,r-is_input_emptyr[rSr# startswithr3r.rBr]r_rN exit_json)rr r rrrbr%r5r6r$r7r0create_tree_quota_objnas_server_resourcer/result error_messagefilesystem_objquota_tree_id_presents rperform_module_operationz"QuotaTree.perform_module_operations  **?; ++,,->?++,,->? **?; ;;%%j1 ""7+[['' 5 [['' 5 {{!!&)kk((7  **?; $" ###%#   *(*:H %00<AM IIm $ KK ! !m ! 4 %00<AM 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 &q),, %%*F%G   ##D) %%*I%J__S) %%+U%V$)@ %%*b%c $ @ @m \-   _$2BuPYGY ./(,(>(>ujR\?G{)\% !144M*.F& '  Ui/ HH+ ,*.*@*@PZ\fhpAL+NF& '   $(): HH* +*.*@*@*OF& '  I -";/3/`/`an/oF+ ,/1F+ , % &&1D*EPcId $F9  ''r )NNN)NN) __name__ __module__ __qualname____doc__rr3rBrNrSr[r]r_rtrhr rr r !s6*2$:#0J06$1L18+0Z0(O(r r c.ttddtddtddddgtddtddtddgd tddtddtddtddd tdd S) zYThis method provide parameters required for the ansible quota tree module on UnityFr<)requiredtypeTr&rg)rzr{choicesrK)MBreTB)rzr{no_log) r r r%r5r6rbr0rrr$r7)rirhr rrrs E6e%8Duy(6KLU3U3u5:LME6e%8E6 5uT :%e4  r c8t}|jy)zb Create Unity quota tree object and perform action on it based on user input from playbookN)r rt)objs rmainrs +C  "r __main__N)rx __future__rrrr{ __metaclass__ DOCUMENTATIONEXAMPLESRETURNansible.module_utils.basicrCansible_collections.dellemc.unity.plugins.module_utils.storage.dellr get_loggerr+robjectr rrrurhr rrs 6@@ Y v\ |Q f5e|$"D(D(N $# zFr