ansible.windows.win_share 模块 – 管理 Windows 共享

注意

此模块是 ansible.windows 集合（版本 2.5.0）的一部分。

如果您使用的是 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install ansible.windows。您需要其他要求才能使用此模块，请参阅 要求 了解详情。

要在 playbook 中使用它，请指定：ansible.windows.win_share。

概要

  • 添加、修改或删除 Windows 共享并设置共享权限。

要求

执行此模块的主机需要满足以下要求。

  • 由于此模块使用了较新的 cmdlet（如 New-SmbShare），因此只能在 Windows 8 / Windows 2012 或更高版本上运行。

  • 这是因为依赖于 WMI 提供程序 MSFT_SmbShare https://msdn.microsoft.com/en-us/library/hh830471，该提供程序仅在这些 Windows 版本中添加。

参数

参数

注释

caching_mode

字符串

设置此共享的 CachingMode。

选择

  • "BranchCache"

  • "Documents"

  • "Manual" ← (默认)

  • "None"

  • "Programs"

  • "Unknown"

change

字符串

指定应该对共享具有读写访问权限的用户列表，用逗号分隔。

deny

字符串

指定应该无权访问（无论共享上隐含的访问权限如何）的用户列表，用逗号分隔。

description

字符串

共享描述。

encrypt

布尔值

设置是否加密到共享的流量。

选择

  • false ← (默认)

  • true

full

字符串

指定应该对共享具有完全访问权限的用户列表，用逗号分隔。

list

布尔值

指定在用户对共享没有权限的情况下，是允许还是拒绝文件列表。也称为基于访问的枚举。

选择

  • false ← (默认)

  • true

name

字符串 / 必需

共享名称。

path

路径 / 必需

共享目录。

read

字符串

指定应该对共享具有读取访问权限的用户列表，用逗号分隔。

rule_action

字符串

是添加还是设置（替换）访问控制条目。

选择

  • "set" ← (默认)

  • "add"

scope_name

字符串

在 ansible.windows 2.2.0 中添加

指定共享的范围名称。用于 Windows Server 故障转移群集文件服务器资源。

定义后，path 必须位于群集共享卷/磁盘上。

state

字符串

指定是添加 present 还是删除 absent 指定的共享。

选择

  • "absent"

  • "present" ← (默认)

示例

- 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

返回值

通用返回值记录在 此处，以下是此模块特有的字段

键

描述

actions

列表 / 元素=字符串

模块运行的 cmdlet 操作列表。

返回：成功

示例： ["New-SmbShare -Name share -Path C:\\temp"]

作者

  • Hans-Joachim Kliemeck (@h0nIg)

  • David Baumann (@daBONDi)

  • Shachaf Goldstein (@Shachaf92)

  • Joe Zollo (@zollo)