You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

win_share - Manage Windows shares¶

New in version 2.1.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
- Status
- Maintenance Info

Synopsis ¶

Add, modify or remove Windows share and set share permissions.

Requirements (on host that executes module)¶

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 https://msdn.microsoft.com/en-us/library/hh830471 which was only added with these Windows releases.

Options ¶

parameter	required	default	choices	comments
caching_mode (added in 2.3)	no	Manual	BranchCache Documents Manual None Programs Unknown	Set the CachingMode for this share.
change	no			Specify user list that should get read and write access on share, separated by comma.
deny	no			Specify user list that should get no access, regardless of implied access on share, separated by comma.
description	no			Share description
encrypt (added in 2.4)	no	no	yes no	Sets whether to encrypt the traffic to the share or not.
full	no			Specify user list that should get full access on share, separated by comma.
list	no	no	yes no	Specify whether to allow or deny file listing, in case user got no permission on share.
name	yes			Share name.
path	yes			Share directory.
read	no			Specify user list that should get read access on share, separated by comma.
state	no	present	present absent	Specify whether to add `present` or remove `absent` the specified share.

Examples ¶

# Playbook example
# Add share and set permissions
---
- name: Add secret share
  win_share:
    name: internal
    description: top secret share
    path: C:\shares\internal
    list: no
    full: Administrators,CEO
    read: HR-Global
    deny: HR-External

- name: Add public company share
  win_share:
    name: company
    description: top secret share
    path: C:\shares\company
    list: yes
    full: Administrators,CEO
    read: Global

- name: Remove previously added share
  win_share:
    name: internal
    state: absent

Return Values ¶

Common return values are documented here Return Values, the following are the fields unique to this module:

name	description	returned	type	sample
actions	A list of action cmdlets that were run by the module.	success	list	['New-SmbShare -Name share -Path C:\\temp']

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance Info ¶

For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.