Resource Type: dsc_smbshare

Defined in:
lib/puppet/type/dsc_smbshare.rb

Overview

The DSC SmbShare resource type. Automatically generated from version 9.1.0

Properties

  • dsc_cachingmode

    Specifies the caching mode of the offline files for the SMB share.

  • dsc_changeaccess

    Specifies which accounts will be granted modify permission to access the SMB share.

  • dsc_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_continuouslyavailable

    Specifies whether the SMB share should be continuously available.

  • dsc_description

    Specifies the description of the SMB share.

  • dsc_encryptdata

    Indicates that the SMB share is encrypted.

  • dsc_ensure

    Specifies if the SMB share should be added or removed.

  • dsc_folderenumerationmode

    Specifies which files and folders in the new SMB share are visible to users.

  • dsc_fullaccess

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

  • dsc_noaccess

    Specifies which accounts are denied access to the SMB share.

  • dsc_path

    Specifies the path of the SMB share.

  • dsc_readaccess

    Specifies which accounts is granted read permission to access the SMB share.

  • dsc_scopename

    Specifies the scope in which the share should be created.

  • dsc_shadowcopy

    Specifies if this SMB share is a ShadowCopy.

  • dsc_sharestate

    Specifies the state of the SMB share.

  • dsc_sharetype

    Specifies the type of the SMB share.

  • dsc_special

    Specifies if this SMB share is a special share. E.g. an admin share, default shares, or IPC$ share.

Parameters

  • dsc_force

    Specifies if the SMB share is allowed to be dropped and recreated (required when the path changes).

  • dsc_name (namevar)

    Specifies the name of the SMB share.

  • dsc_psdscrunascredential
  • dsc_timeout

    The maximum time in seconds to wait for the DSC resource to complete.

  • name (namevar)

    Description of the purpose for this resource declaration.

  • validation_mode (defaults to: property)

    Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).