win_share – Manage Windows shares

• Synopsis
• Requirements
• Parameters
• Examples
• Return Values
• Status

Synopsis

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

Requirements

The below requirements are needed on the host that executes this 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.

Parameters

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, the following are the fields unique to this module:

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]
• This module is maintained by the Ansible Core Team. [core]

Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

Authors

• Hans-Joachim Kliemeck (@h0nIg)
• David Baumann (@daBONDi)