Merge pull request #96 from dsccommunity/DSC_CMEmailNotificationCompo…

…nent

Dsc_CMEmailNotificationComponent additional resource

CHANGELOG.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Added ConfigMgrCBDsc.ReverseDsc module
+- Added CMEmailNotificationComponent
 
 ### Fixed
 

README.md

@@ -124,6 +124,8 @@ Please check out common DSC Community [contributing guidelines](https://dsccommu
   maintenance windows for collections.
 - **CMFileReplication**: Provides a resource for creating, modifying, or deleting
   file replication settings in Configuration Manager.
+- **CMEmailNotificationComponent**: Provides a resource for modifying email notification
+  component settings.
 
 ### xSccmPreReqs
 
@@ -1336,6 +1338,29 @@ you are using apply and auto correct.
 - [CMFileReplication_Present](Source\Examples\Resources\CMFileReplication\CMFileReplication_Present.ps1)
 - [CMFileReplication_Absent](Source\Examples\Resources\CMFileReplication\CMFileReplication_Absent.ps1)
 
+### CMEmailNotificationComponent
+
+- **[String] SiteCode** _(Key)_: Specifies the Site Code for the Configuration
+  Manager site.
+- **[String] Enabled** _(Key)_: Specifies if email notifications are
+  enabled or disabled.
+- **[String] SmtpServerFqdn** _(Write)_: Specifies the FQDN of the site server that
+  will send email.
+- **[String] SendFrom** _(Write)_: Specifies the address used to send email.
+- **[UInt32] Port** _(Write)_: Specifies the port used to send email.
+- **[String] UserName** _(Write)_: Specifies the username for authenticating against
+  an SMTP server. Only used when AuthenticationMethod equals Other.
+- **[Boolean] UseSsl** _(Write)_: Specifies whether to use SSL for email alerts.
+  If omitted, the assumed intent is that SSL is not to be used.
+- **[String] TypeOfAuthentication** _(Write)_: Specifies the method by which
+  Configuration Manager authenticates the site server to the SMTP Server.
+  - Values include: {Anonymous|DefaultServiceAccount|Other}
+
+#### CMEmailNotificationComponent Examples
+
+- [CMEmailNotificationComponent_Present](Source\Examples\Resources\CMEmailNotificationComponent\CMEmailNotificationComponent_Present.ps1)
+- [CMEmailNotificationComponent_Absent](Source\Examples\Resources\CMEmailNotificationComponent\CMEmailNotificationComponent_Absent.ps1)
+
 ## ReverseDsc
 
 Most organizations using this module already have an existing Configuration Manager
@@ -1388,6 +1413,7 @@ all of the modules and specify if it is currently supported by ReverseDSC.
 - DSC_CMDistributionGroup: Fully Supported
 - DSC_CMDistributionPoint: Fully Supported
 - DSC_CMDistributionPointGroupMembers: Fully Supported
+- DSC_CMEmailNotificationComponent: Fully Supported
 - DSC_CMFallbackStatusPoint: Fully Supported
 - DSC_CMFileReplication: Not Supported
 - DSC_CMForestDiscovery: Fully Supported
@@ -1434,7 +1460,7 @@ After importing the module, Set-ConfigMgrCBDscReverse will be available.
   default setting: All.
   - Values include: { All|Accounts|AdministrativeUser|AssetIntelligencePoint|BoundaryGroups|
   ClientPush|ClientStatusSettings|CollectionEvaluationComponent|Collections|
-  DistributionGroups|DistributionPoint|DistributionPointGroupMembers|
+  DistributionGroups|DistributionPoint|DistributionPointGroupMembers|EmailNotificationComponent|
   FallbackPoints|ForestDiscovery|HeartbeatDiscovery|MaintenanceWindow|ManagementPoint|
   NetworkDiscovery|PullDistributionPoint|PxeDistributionPoint|
   ReportingServicesPoint|SecurityScopes|ServiceConnection|SiteMaintenance|
@@ -1444,7 +1470,7 @@ After importing the module, Set-ConfigMgrCBDscReverse will be available.
   being evaluated. Only evaluated when Include = 'All'
   - Values include: { Accounts|AdministrativeUser|AssetIntelligencePoint|BoundaryGroups|
   ClientPush|ClientStatusSettings|CollectionEvaluationComponent|Collections|
-  DistributionGroups|DistributionPoint|DistributionPointGroupMembers|
+  DistributionGroups|DistributionPoint|DistributionPointGroupMembers|EmailNotificationComponent|
   FallbackPoints|ForestDiscovery|HeartbeatDiscovery|MaintenanceWindow|ManagementPoint|
   NetworkDiscovery|PullDistributionPoint|PxeDistributionPoint|
   ReportingServicesPoint|SecurityScopes|ServiceConnection|SiteMaintenance|

RequiredModules.psd1

@@ -19,7 +19,7 @@
     'DscResource.Test'          = 'latest'
     'DscResource.AnalyzerRules' = 'latest'
     xDscResourceDesigner        = 'latest'
-    'DscResource.DocGenerator'  = 'latest'
+    'DscResource.DocGenerator'  = '0.8.3'
 
     # Build dependent modules
     'DscResource.Common'        = 'latest'

source/ConfigMgrCBDsc.psd1

@@ -79,6 +79,7 @@
         'CMSoftwareDistributionComponent'
         'CMMaintenanceWindows'
         'CMFileReplication'
+        'CMEmailNotificationComponent'
     )
 
     <#
@@ -97,7 +98,7 @@
             'ServiceConnectionPoint','NetworkDiscovery','ReportingServicePoint','SystemDiscovery','PXEDistributionPoint','PullDistributionPoint',
             'SiteMaintenance','AdministrativeUser','DistributionGroup','SiteSystemServer','StatusReportingComponent','CollectionMembershipEvaluationComponent',
             'DistributionPointGroupMembers','SecurityScopes','UserDiscovery','SecurityRoles','ClientPushSettings','SoftwareDistributionComponent',
-            'MaintenanceWindows','FileReplication')
+            'MaintenanceWindows','FileReplication','EmailNotificationComponent')
 
             # A URL to the license for this module.
             LicenseUri   = 'https://github.com/dsccommunity/ConfigMgrCBDsc/blob/master/LICENSE'