Resource Type: dsc_xsmbshare

Defined in:

lib/puppet/type/dsc_xsmbshare.rb

Providers:

powershell

Overview

The DSC xSmbShare resource type. Automatically generated from ‘xSmbShare/DscResources/MSFT_xSmbShare/MSFT_xSmbShare.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present
  • absent

Parameters

• dsc_changeaccess

  ChangeAccess - Specifies which user will be granted modify permission to access the share

• dsc_concurrentuserlimit

  ConcurrentUserLimit - Specifies the maximum number of concurrently connected users that the new SMB share may accommodate. If this parameter is set to zero (0), then the number of users is unlimited. The default value is zero (0).

• dsc_description

  Description - Description of the share

• dsc_encryptdata

  EncryptData - Indicates that the share is encrypted.

  Supported values:

  • true
  • false
• dsc_ensure

  Ensure - Specifies if the share should be added or removed Valid values are Present, Absent.

• dsc_folderenumerationmode

  FolderEnumerationMode - Specifies which files and folders in the new SMB share are visible to users. Valid values are AccessBased, Unrestricted.

• dsc_fullaccess

  FullAccess - Specifies which accounts are granted full permission to access the share.

• dsc_name

  Name - Name of the SMB Share

• dsc_noaccess

  NoAccess - Specifies which accounts are denied access to the share.

• dsc_path

  Path - Path to the share

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_readaccess

  ReadAccess - Specifies which user is granted read permission to access the share.

• dsc_shadowcopy

  ShadowCopy - Specifies if this share is a ShadowCopy

• dsc_sharestate

  ShareState - Specfies the state of the share

• dsc_sharetype

  ShareType - Specfies the type of the share

• dsc_special

  Special - Specifies if this share is a Special Share. Admin share, default shares, IPC$ share are examples.

• name (namevar)
• provider

  The specific backend to use for this ‘dsc_xsmbshare` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.