Version information
This version is compatible with:
- Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x
- Puppet >= 6.0.0 < 8.0.0
Start using this module
Add this module to your Puppetfile:
mod 'dsc-fsrmdsc', '2.3.0-132-1'
Learn more about managing modules with a PuppetfileDocumentation
Table of Contents
Description
This is an auto-generated module, using the Puppet DSC Builder to vendor and expose the PowerShell module's DSC resources as Puppet resources. The functionality of this module comes entirely from the vendored PowerShell resources, which are pinned at v2.3.0.132. The PowerShell module describes itself like this:
DSC Resources for File Server Resource Manager configuration
For information on troubleshooting to determine whether any encountered problems are with the Puppet wrapper or the DSC resource, see the troubleshooting section below.
Requirements
This module, like all auto-generated Puppetized DSC modules, relies on two important technologies in the Puppet stack: the Puppet Resource API and the puppetlabs/pwshlib Puppet module.
The Resource API provides a simplified option for writing types and providers and is responsible for how this module is structured. The Resource API ships inside of Puppet starting with version 6. While it is technically possible to add the Resource API functionality to Puppet 5.5.x, the DSC functionality has not been tested in this setup. For more information on the Resource API, review the documentation.
The module also depends on the pwshlib module. This Puppet module includes two important things: the ruby-pwsh library for running PowerShell code from ruby and the base provider for DSC resources, which this module leverages.
All of the actual work being done to call the DSC resources vendored with this module is in this file from the pwshlib module. This is important for troubleshooting and bug reporting, but doesn't impact your use of the module except that the end result will be that nothing works, as the dependency is not installed alongside this module!
Usage
You can specify any of the DSC resources from this module like a normal Puppet resource in your manifests. The examples below use DSC resources from from the PowerShellGet repository, regardless of what module you're looking at here; the syntax, not the specifics, is what's important.
For reference documentation about the DSC resources exposed in this module, see the Reference Forge tab, or the REFERENCE.md file.
# Include a meaningful title for your resource declaration
dsc_psrepository { 'Add team module repo':
dsc_name => 'foo',
dsc_ensure => present,
# This location is nonsense, can be any valid folder on your
# machine or in a share, any location the SourceLocation param
# for the DSC resource will accept.
dsc_sourcelocation => 'C:\Program Files',
# You must always pass an enum fully lower-cased;
# Puppet is case sensitive even when PowerShell isn't
dsc_installationpolicy => untrusted,
}
dsc_psrepository { 'Trust public gallery':
dsc_name => 'PSGallery',
dsc_ensure => present,
dsc_installationpolicy => trusted,
}
dsc_psmodule { 'Make Ruby manageable via uru':
dsc_name => 'RubyInstaller',
dsc_ensure => present,
}
For more information about using a built module, check out our narrative documentation.
Properties
Note that the only properties specified in a resource declaration which are passed to Invoke-Dsc are all prepended with dsc.
If a property does _not start with dsc_ it is used to control how Puppet interacts with DSC/other Puppet resources - for example,
specifying a unique name for the resource for Puppet to distinguish between declarations or Puppet metaparameters (notifies,
before, etc).
Troubleshooting
In general, there are three broad categories of problems:
- Problems with the way the underlying DSC resource works.
- Problems with the type definition, where you can't specify a valid set of properties for the DSC resource
- Problems with calling the underlying DSC resource - the parameters aren't being passed correctly or the resource can't be found
Unfortunately, problems with the way the underlying DSC resource works are something we can't help directly with. You'll need to file an issue with the upstream maintainers for the PowerShell module.
Problems with the type definition are when a value that should be valid according to the DSC resource's documentation and code is not accepted by the Puppet wrapper. If and when you run across one of these, please file an issue with the Puppet DSC Builder; this is where the conversion happens and once we know of a problem we can fix it and regenerate the Puppet modules. To help us identify the issue, please specify the DSC module, version, resource, property and values that are giving you issues. Once a fix is available we will regenerate and release updated versions of this Puppet wrapper.
Problems with calling the underlying DSC resource become apparent by comparing <value passed in in puppet>
with <value received by DSC>
.
In this case, please file an issue with the puppetlabs/pwshlib module, which is where the DSC base provider actually lives.
We'll investigate and prioritize a fix and update the puppetlabs/pwshlib module.
Updating to the pwshlib version with the fix will immediately take advantage of the improved functionality without waiting for this module to be reconverted and published.
For specific information on troubleshooting a generated module, check the troubleshooting guide for the puppet.dsc module.
Known Limitations
Currently, because of the way Puppet caches files on agents, use of the legacy puppetlabs-dsc
module is not compatible with this or any auto-generated DSC module.
Inclusion of both will lead to pluginsync conflicts.
Reference
Table of Contents
Resource types
dsc_fsrmautoquota
: The DSC FSRMAutoQuota resource type. Automatically generated from version 2.3.0.132dsc_fsrmclassification
: The DSC FSRMClassification resource type. Automatically generated from version 2.3.0.132dsc_fsrmclassificationproperty
: The DSC FSRMClassificationProperty resource type. Automatically generated from version 2.3.0.132dsc_fsrmclassificationpropertyvalue
: The DSC FSRMClassificationPropertyValue resource type. Automatically generated from version 2.3.0.132dsc_fsrmclassificationrule
: The DSC FSRMClassificationRule resource type. Automatically generated from version 2.3.0.132dsc_fsrmfilegroup
: The DSC FSRMFileGroup resource type. Automatically generated from version 2.3.0.132dsc_fsrmfilescreen
: The DSC FSRMFileScreen resource type. Automatically generated from version 2.3.0.132dsc_fsrmfilescreenaction
: The DSC FSRMFileScreenAction resource type. Automatically generated from version 2.3.0.132dsc_fsrmfilescreenexception
: The DSC FSRMFileScreenException resource type. Automatically generated from version 2.3.0.132dsc_fsrmfilescreentemplate
: The DSC FSRMFileScreenTemplate resource type. Automatically generated from version 2.3.0.132dsc_fsrmfilescreentemplateaction
: The DSC FSRMFileScreenTemplateAction resource type. Automatically generated from version 2.3.0.132dsc_fsrmquota
: The DSC FSRMQuota resource type. Automatically generated from version 2.3.0.132dsc_fsrmquotaaction
: The DSC FSRMQuotaAction resource type. Automatically generated from version 2.3.0.132dsc_fsrmquotatemplate
: The DSC FSRMQuotaTemplate resource type. Automatically generated from version 2.3.0.132dsc_fsrmquotatemplateaction
: The DSC FSRMQuotaTemplateAction resource type. Automatically generated from version 2.3.0.132dsc_fsrmsettings
: The DSC FSRMSettings resource type. Automatically generated from version 2.3.0.132
Resource types
dsc_fsrmautoquota
The DSC FSRMAutoQuota resource type. Automatically generated from version 2.3.0.132
Properties
The following properties are available in the dsc_fsrmautoquota
type.
dsc_disabled
Data type: Optional[Boolean]
Disables the FSRM Quota applied to this path.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Specifies whether the FSRM Quota should exist.
dsc_template
Data type: Optional[String]
The name of the FSRM Quota Template to apply to this path.
Parameters
The following parameters are available in the dsc_fsrmautoquota
type.
dsc_path
namevar
Data type: String
The path this FSRM Quota applies to.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_fsrmclassification
The DSC FSRMClassification resource type. Automatically generated from version 2.3.0.132
Properties
The following properties are available in the dsc_fsrmclassification
type.
dsc_continuous
Data type: Optional[Boolean]
Enable FSRM Classification continuous mode for new files.
dsc_continuouslog
Data type: Optional[Boolean]
Enable FSRM Classification continuous mode logging.
dsc_continuouslogsize
Data type: Optional[Integer[0, 4294967295]]
The maximum number of KB that can be used for the continuous mode log file.
dsc_excludenamespace
Data type: Optional[Array[String]]
An array of Namespaces that will be excluded from FSRM Classification.
dsc_lasterror
Data type: Optional[String]
dsc_schedulemonthly
Data type: Optional[Array[Integer[0, 4294967295]]]
An array of days of the month the FSRM Classification should run on.
dsc_schedulerunduration
Data type: Optional[Integer[-2147483648, 2147483647]]
The maximum number of hours the FSRM Classification can run for. Setting this to -1 will disable this.
dsc_scheduletime
Data type: Optional[String]
A string containing the time of day the FSRM Classification should run at.
dsc_scheduleweekly
Data type: Optional[Array[String]]
An array of named days of the week the FSRM Classification should run on.
dsc_status
Data type: Optional[String]
Parameters
The following parameters are available in the dsc_fsrmclassification
type.
dsc_id
namevar
Data type: String
This is a unique identifier for this resource.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_fsrmclassificationproperty
The DSC FSRMClassificationProperty resource type. Automatically generated from version 2.3.0.132
Properties
The following properties are available in the dsc_fsrmclassificationproperty
type.
dsc_description
Data type: Optional[String]
The description for the FSRM Classification Property.
dsc_displayname
Data type: Optional[String]
The display name for the FSRM Classification Property.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Specifies whether the FSRM Classification Property should exist.
dsc_parameters
Data type: Optional[Array[String]]
An array of parameters in the format = that can be used by the File Classification Infrastructure.
dsc_possiblevalue
Data type: Optional[Array[String]]
An array of possible values that this FSRM Classification Property can take on.
dsc_type
Data type: Enum['OrderedList', 'MultiChoice', 'SingleChoice', 'String', 'MultiString', 'Integer', 'YesNo', 'DateTime']
The type of the FSRM Classification Property.
Parameters
The following parameters are available in the dsc_fsrmclassificationproperty
type.
dsc_name
namevar
Data type: String
The name of the FSRM Classification Property.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_fsrmclassificationpropertyvalue
The DSC FSRMClassificationPropertyValue resource type. Automatically generated from version 2.3.0.132
Properties
The following properties are available in the dsc_fsrmclassificationpropertyvalue
type.
dsc_description
Data type: Optional[String]
The description of the FSRM Classification Property value.
dsc_displayname
Data type: Optional[String]
The FSRM Classification Property value Display Name.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Specifies whether the FSRM Classification Property value should exist.
Parameters
The following parameters are available in the dsc_fsrmclassificationpropertyvalue
type.
dsc_name
namevar
Data type: String
The FSRM Classification Property value Name.
dsc_propertyname
namevar
Data type: String
The name of the FSRM Classification Property the value applies to.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_fsrmclassificationrule
The DSC FSRMClassificationRule resource type. Automatically generated from version 2.3.0.132
Properties
The following properties are available in the dsc_fsrmclassificationrule
type.
dsc_classificationmechanism
Data type: Optional[String]
Specifies the name of a valid classification mechanism available on the server for assigning the property value.
dsc_contentregularexpression
Data type: Optional[Array[String]]
An array of regular expressions for pattern matching.
dsc_contentstring
Data type: Optional[Array[String]]
An array of strings for the content classifier to search for.
dsc_contentstringcasesensitive
Data type: Optional[Array[String]]
An array of case sensitive strings for the content classifier to search for.
dsc_description
Data type: Optional[String]
The description for the FSRM Classification Rule.
dsc_disabled
Data type: Optional[Boolean]
Indicates that the classification rule is disabled.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Specifies whether the FSRM Classification Rule should exist.
dsc_flags
Data type: Optional[Array[String]]
An array of flags that defines the possible states of the rule.
dsc_namespace
Data type: Optional[Array[String]]
An array of namespaces where the rule is applied.
dsc_parameters
Data type: Optional[Array[String]]
An array of parameters in the format = that can be used by the File Classification Infrastructure.
dsc_property
Data type: Optional[String]
Specifies the name of a classification property definition to set.
dsc_propertyvalue
Data type: Optional[String]
Specifies the property value that the rule will assign.
dsc_reevaluateproperty
Data type: Optional[Enum['Never', 'Overwrite', 'Aggregate']]
Specifies the evaluation policy of the rule.
Parameters
The following parameters are available in the dsc_fsrmclassificationrule
type.
dsc_name
namevar
Data type: String
The name of the FSRM Classification Rule.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_fsrmfilegroup
The DSC FSRMFileGroup resource type. Automatically generated from version 2.3.0.132
Properties
The following properties are available in the dsc_fsrmfilegroup
type.
dsc_description
Data type: Optional[String]
The description for the FSRM File Group.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Specifies whether the FSRM File Group should exist.
dsc_excludepattern
Data type: Optional[Array[String]]
An array of file patterns to exclude in this FSRM File Group.
dsc_includepattern
Data type: Optional[Array[String]]
An array of file patterns to include in this FSRM File Group.
Parameters
The following parameters are available in the dsc_fsrmfilegroup
type.
dsc_name
namevar
Data type: String
The name of the FSRM File Group.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_fsrmfilescreen
The DSC FSRMFileScreen resource type. Automatically generated from version 2.3.0.132
Properties
The following properties are available in the dsc_fsrmfilescreen
type.
dsc_active
Data type: Optional[Boolean]
Boolean setting that controls if server should fail any I/O operations if the File Screen is violated.
dsc_description
Data type: Optional[String]
An optional description for this FSRM File Screen.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Specifies whether the FSRM File Screen should exist.
dsc_includegroup
Data type: Optional[Array[String]]
An array of File Groups to include in this File Screen.
dsc_matchestemplate
Data type: Optional[Boolean]
Causes the template to use only the template name and Active and Ignore Groups parameters.
dsc_template
Data type: Optional[String]
The name of the FSRM File Screen Template to apply to this path.
Parameters
The following parameters are available in the dsc_fsrmfilescreen
type.
dsc_path
namevar
Data type: String
The path this FSRM File Screen applies to.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_fsrmfilescreenaction
The DSC FSRMFileScreenAction resource type. Automatically generated from version 2.3.0.132
Properties
The following properties are available in the dsc_fsrmfilescreenaction
type.
dsc_body
Data type: Optional[String]
The body text of the e-mail or event. Required when Type is Email or Event.
dsc_command
Data type: Optional[String]
The Command to execute. Required when Type is Command.
dsc_commandparameters
Data type: Optional[String]
The Command Parameters. Required when Type is Command.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Specifies whether the FSRM Action should exist.
dsc_eventtype
Data type: Optional[Enum['None', 'Information', 'Warning', 'Error']]
The type of event created. Required when Type is Event.
dsc_killtimeout
Data type: Optional[Integer[-2147483648, 2147483647]]
Int containing kill timeout of the command. Required when Type is Command.
dsc_mailbcc
Data type: Optional[String]
The mail BCC of the e-mail sent. Required when Type is Email.
dsc_mailcc
Data type: Optional[String]
The mail CC of the e-mail sent. Required when Type is Email.
dsc_mailto
Data type: Optional[String]
The mail to of the e-mail sent. Required when Type is Email.
dsc_reporttypes
Data type: Optional[Array[String]]
Array of Reports to create. Required when Type is Report.
dsc_runlimitinterval
Data type: Optional[Integer[-2147483648, 2147483647]]
Int containing the run limit interval of the command. Required when Type is Command.
dsc_securitylevel
Data type: Optional[Enum['None', 'LocalService', 'NetworkService', 'LocalSystem']]
The security level the command runs under. Required when Type is Command.
dsc_shouldlogerror
Data type: Optional[Boolean]
The working directory of the command. Required when Type is Command.
dsc_subject
Data type: Optional[String]
The subject of the e-mail sent. Required when Type is Email.
dsc_workingdirectory
Data type: Optional[String]
The type of event created. Required when Type is Event.
Parameters
The following parameters are available in the dsc_fsrmfilescreenaction
type.
dsc_path
namevar
Data type: String
The path of the FSRM File Screen the action applies to.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_type
namevar
Data type: Enum['Email', 'Event', 'Command', 'Report']
The type of FSRM Action.
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_fsrmfilescreenexception
The DSC FSRMFileScreenException resource type. Automatically generated from version 2.3.0.132
Properties
The following properties are available in the dsc_fsrmfilescreenexception
type.
dsc_description
Data type: Optional[String]
An optional description for this FSRM File Screen.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Specifies whether the FSRM File Screen should exist.
dsc_includegroup
Data type: Optional[Array[String]]
An array of File Groups to include in this File Screen.
Parameters
The following parameters are available in the dsc_fsrmfilescreenexception
type.
dsc_path
namevar
Data type: String
The path this FSRM File Screen applies to.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_fsrmfilescreentemplate
The DSC FSRMFileScreenTemplate resource type. Automatically generated from version 2.3.0.132
Properties
The following properties are available in the dsc_fsrmfilescreentemplate
type.
dsc_active
Data type: Optional[Boolean]
Boolean setting that controls if server should fail any I/O operations if the File Screen is violated.
dsc_description
Data type: Optional[String]
An optional description for this FSRM File Screen Template.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Specifies whether the FSRM File Screen Template should exist.
dsc_includegroup
Data type: Optional[Array[String]]
An array of File Groups to include in this File Screen.
Parameters
The following parameters are available in the dsc_fsrmfilescreentemplate
type.
dsc_name
namevar
Data type: String
The unique name for this FSRM File Screen Template.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_fsrmfilescreentemplateaction
The DSC FSRMFileScreenTemplateAction resource type. Automatically generated from version 2.3.0.132
Properties
The following properties are available in the dsc_fsrmfilescreentemplateaction
type.
dsc_body
Data type: Optional[String]
The body text of the e-mail or event. Required when Type is Email or Event.
dsc_command
Data type: Optional[String]
The Command to execute. Required when Type is Command.
dsc_commandparameters
Data type: Optional[String]
The Command Parameters. Required when Type is Command.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Specifies whether the FSRM Action should exist.
dsc_eventtype
Data type: Optional[Enum['None', 'Information', 'Warning', 'Error']]
The type of event created. Required when Type is Event.
dsc_killtimeout
Data type: Optional[Integer[-2147483648, 2147483647]]
Int containing kill timeout of the command. Required when Type is Command.
dsc_mailbcc
Data type: Optional[String]
The mail BCC of the e-mail sent. Required when Type is Email.
dsc_mailcc
Data type: Optional[String]
The mail CC of the e-mail sent. Required when Type is Email.
dsc_mailto
Data type: Optional[String]
The mail to of the e-mail sent. Required when Type is Email.
dsc_reporttypes
Data type: Optional[Array[String]]
Array of Reports to create. Required when Type is Report.
dsc_runlimitinterval
Data type: Optional[Integer[-2147483648, 2147483647]]
Int containing the run limit interval of the command. Required when Type is Command.
dsc_securitylevel
Data type: Optional[Enum['None', 'LocalService', 'NetworkService', 'LocalSystem']]
The security level the command runs under. Required when Type is Command.
dsc_shouldlogerror
Data type: Optional[Boolean]
Boolean specifying if command errors should be logged. Required when Type is Command.
dsc_subject
Data type: Optional[String]
The subject of the e-mail sent. Required when Type is Email.
dsc_workingdirectory
Data type: Optional[String]
The working directory of the command. Required when Type is Command.
Parameters
The following parameters are available in the dsc_fsrmfilescreentemplateaction
type.
dsc_name
namevar
Data type: String
The name of the FSRM File Screen Template that this Action is attached to.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_type
namevar
Data type: Enum['Email', 'Event', 'Command', 'Report']
The type of FSRM Action.
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_fsrmquota
The DSC FSRMQuota resource type. Automatically generated from version 2.3.0.132
Properties
The following properties are available in the dsc_fsrmquota
type.
dsc_description
Data type: Optional[String]
An optional description for this FSRM Quota.
dsc_disabled
Data type: Optional[Boolean]
Disables the FSRM Quota applied to this path.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Specifies whether the FSRM Quota should exist.
dsc_matchestemplate
Data type: Optional[Boolean]
Causes the template to use only the template name and ignore Size, SoftLimit and ThresholdPercentage parameters.
dsc_size
Data type: Optional[Integer[-9223372036854775808, 9223372036854775807]]
The size in bytes of this FSRM Quota limit.
dsc_softlimit
Data type: Optional[Boolean]
Controls whether this FSRM Quota has a hard or soft limit.
dsc_template
Data type: Optional[String]
The name of the FSRM Quota Template to apply to this path.
dsc_thresholdpercentages
Data type: Optional[Array[Integer[0, 4294967295]]]
An array of threshold percentages in this FSRM Quota.
Parameters
The following parameters are available in the dsc_fsrmquota
type.
dsc_path
namevar
Data type: String
The path this FSRM Quota applies to.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_fsrmquotaaction
The DSC FSRMQuotaAction resource type. Automatically generated from version 2.3.0.132
Properties
The following properties are available in the dsc_fsrmquotaaction
type.
dsc_body
Data type: Optional[String]
The body text of the e-mail or event. Required when Type is Email or Event.
dsc_command
Data type: Optional[String]
The Command to execute. Required when Type is Command.
dsc_commandparameters
Data type: Optional[String]
The Command Parameters. Required when Type is Command.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Specifies whether the FSRM Action should exist.
dsc_eventtype
Data type: Optional[Enum['None', 'Information', 'Warning', 'Error']]
The type of event created. Required when Type is Event.
dsc_killtimeout
Data type: Optional[Integer[-2147483648, 2147483647]]
Int containing kill timeout of the command. Required when Type is Command.
dsc_mailbcc
Data type: Optional[String]
The mail BCC of the e-mail sent. Required when Type is Email.
dsc_mailcc
Data type: Optional[String]
The mail CC of the e-mail sent. Required when Type is Email.
dsc_mailto
Data type: Optional[String]
The mail to of the e-mail sent. Required when Type is Email.
dsc_reporttypes
Data type: Optional[Array[String]]
Array of Reports to create. Required when Type is Report.
dsc_runlimitinterval
Data type: Optional[Integer[-2147483648, 2147483647]]
Int containing the run limit interval of the command. Required when Type is Command.
dsc_securitylevel
Data type: Optional[Enum['None', 'LocalService', 'NetworkService', 'LocalSystem']]
The security level the command runs under. Required when Type is Command.
dsc_shouldlogerror
Data type: Optional[Boolean]
Boolean specifying if command errors should be logged. Required when Type is Command.
dsc_subject
Data type: Optional[String]
The subject of the e-mail sent. Required when Type is Email.
dsc_workingdirectory
Data type: Optional[String]
The working directory of the command. Required when Type is Command.
Parameters
The following parameters are available in the dsc_fsrmquotaaction
type.
dsc_path
namevar
Data type: String
The path of the FSRM Quota the action applies to.
dsc_percentage
namevar
Data type: Integer[0, 4294967295]
This is the threshold percentage the action is attached to.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_type
namevar
Data type: Enum['Email', 'Event', 'Command', 'Report']
The type of FSRM Action.
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_fsrmquotatemplate
The DSC FSRMQuotaTemplate resource type. Automatically generated from version 2.3.0.132
Properties
The following properties are available in the dsc_fsrmquotatemplate
type.
dsc_description
Data type: Optional[String]
An optional description for this FSRM Quota Template.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Specifies whether the FSRM Quota Template should exist.
dsc_size
Data type: Optional[Integer[-9223372036854775808, 9223372036854775807]]
The size in bytes of this FSRM Quota Template limit.
dsc_softlimit
Data type: Optional[Boolean]
Controls whether this FSRM Quota Template has a hard or soft limit.
dsc_thresholdpercentages
Data type: Optional[Array[Integer[0, 4294967295]]]
An array of threshold percentages in this FSRM Quota Template.
Parameters
The following parameters are available in the dsc_fsrmquotatemplate
type.
dsc_name
namevar
Data type: String
The unique name for this FSRM Quota Template.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_fsrmquotatemplateaction
The DSC FSRMQuotaTemplateAction resource type. Automatically generated from version 2.3.0.132
Properties
The following properties are available in the dsc_fsrmquotatemplateaction
type.
dsc_body
Data type: Optional[String]
The body text of the e-mail or event. Required when Type is Email or Event.
dsc_command
Data type: Optional[String]
The Command to execute. Required when Type is Command.
dsc_commandparameters
Data type: Optional[String]
The Command Parameters. Required when Type is Command.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
Specifies whether the FSRM Action should exist.
dsc_eventtype
Data type: Optional[Enum['None', 'Information', 'Warning', 'Error']]
The type of event created. Required when Type is Event.
dsc_killtimeout
Data type: Optional[Integer[-2147483648, 2147483647]]
Int containing kill timeout of the command. Required when Type is Command.
dsc_mailbcc
Data type: Optional[String]
The mail BCC of the e-mail sent. Required when Type is Email.
dsc_mailcc
Data type: Optional[String]
The mail CC of the e-mail sent. Required when Type is Email.
dsc_mailto
Data type: Optional[String]
The mail to of the e-mail sent. Required when Type is Email.
dsc_reporttypes
Data type: Optional[Array[String]]
Array of Reports to create. Required when Type is Report.
dsc_runlimitinterval
Data type: Optional[Integer[-2147483648, 2147483647]]
Int containing the run limit interval of the command. Required when Type is Command.
dsc_securitylevel
Data type: Optional[Enum['None', 'LocalService', 'NetworkService', 'LocalSystem']]
The security level the command runs under. Required when Type is Command.
dsc_shouldlogerror
Data type: Optional[Boolean]
Boolean specifying if command errors should be logged. Required when Type is Command.
dsc_subject
Data type: Optional[String]
The subject of the e-mail sent. Required when Type is Email.
dsc_workingdirectory
Data type: Optional[String]
The working directory of the command. Required when Type is Command.
Parameters
The following parameters are available in the dsc_fsrmquotatemplateaction
type.
dsc_name
namevar
Data type: String
The name of the FSRM Quota Template that this Action is attached to.
dsc_percentage
namevar
Data type: Integer[0, 4294967295]
This is the threshold percentage the action is attached to.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_type
namevar
Data type: Enum['Email', 'Event', 'Command', 'Report']
The type of FSRM Action.
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_fsrmsettings
The DSC FSRMSettings resource type. Automatically generated from version 2.3.0.132
Properties
The following properties are available in the dsc_fsrmsettings
type.
dsc_adminemailaddress
Data type: Optional[String]
Specifies a semicolon-separated list of email addresses for the recipients of any email that the server sends to the administrator.
dsc_commandnotificationlimit
Data type: Optional[Integer[0, 4294967295]]
Specifies the minimum number of seconds between individual running events of a command-type notification.
dsc_emailnotificationlimit
Data type: Optional[Integer[0, 4294967295]]
Specifies the minimum number of seconds between individual running events of an email-type notification.
dsc_eventnotificationlimit
Data type: Optional[Integer[0, 4294967295]]
Specifies the minimum number of seconds between individual running events of an event-type notification.
dsc_fromemailaddress
Data type: Optional[String]
Specifies the default email address from which FSRM sends email messages.
dsc_smtpserver
Data type: Optional[String]
Specifies the fully qualified domain name (FQDN) or IP address of the SMTP server that FSRM uses to send email.
Parameters
The following parameters are available in the dsc_fsrmsettings
type.
dsc_issingleinstance
namevar
Data type: Enum['Yes']
Specifies the resource is a single instance, the value must be 'Yes'.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
Initial release of FSRMDsc in the DSC Resource Kit
Dependencies
- puppetlabs/pwshlib (>= 0.7.0 < 2.0.0)