Vh%dZdZdZy)a --- module: win_share short_description: Manage Windows shares description: - Add, modify or remove Windows share and set share permissions. requirements: - As this module used newer cmdlets like New-SmbShare this can only run on Windows 8 / Windows 2012 or newer. - This is due to the reliance on the WMI provider MSFT_SmbShare U(https://msdn.microsoft.com/en-us/library/hh830471) which was only added with these Windows releases. options: name: description: - Share name. type: str required: yes path: description: - Share directory. type: path required: yes state: description: - Specify whether to add C(present) or remove C(absent) the specified share. type: str choices: [ absent, present ] default: present description: description: - Share description. type: str list: description: - Specify whether to allow or deny file listing, in case user has no permission on share. Also known as Access-Based Enumeration. type: bool default: no read: description: - Specify user list that should get read access on share, separated by comma. type: str change: description: - Specify user list that should get read and write access on share, separated by comma. type: str full: description: - Specify user list that should get full access on share, separated by comma. type: str deny: description: - Specify user list that should get no access, regardless of implied access on share, separated by comma. type: str caching_mode: description: - Set the CachingMode for this share. type: str choices: [ BranchCache, Documents, Manual, None, Programs, Unknown ] default: Manual scope_name: description: - Specifies the scope name of the share. For use with Windows Server failover cluster file server resources. - When defined, I(path) must be located on a cluster shared volume/disk. type: str version_added: '2.2.0' encrypt: description: Sets whether to encrypt the traffic to the share or not. type: bool default: no rule_action: description: Whether to add or set (replace) access control entries. type: str choices: [ set, add ] default: set author: - Hans-Joachim Kliemeck (@h0nIg) - David Baumann (@daBONDi) - Shachaf Goldstein (@Shachaf92) - Joe Zollo (@zollo) a - name: Add secret share ansible.windows.win_share: name: internal description: top secret share path: C:\shares\internal list: false full: Administrators,CEO read: HR-Global deny: HR-External - name: Add public company share ansible.windows.win_share: name: company description: top secret share path: C:\shares\company list: true full: Administrators,CEO read: Global - name: Add failover cluster role share ansible.windows.win_share: name: backups scope_name: FCMSSQL01 description: SQL Backups path: E:\sqlbackup list: true full: svc.mssql read: Global - name: Remove previously added share ansible.windows.win_share: name: internal state: absent z actions: description: A list of action cmdlets that were run by the module. returned: success type: list sample: ['New-SmbShare -Name share -Path C:\temp'] N) DOCUMENTATIONEXAMPLESRETURNm/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/ansible/windows/plugins/modules/win_share.pyrsP d" H r