All resources - add to NamespaceRoots, NamespaceFolders, Add ReplicationGroups, Connections & Memberships

CHANGELOG.md

@@ -7,6 +7,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Changed
 
+- DFSNamespaceRoot
+  - Added support for setting target referral status (TargetState) - fixes [Issue #96](https://github.com/dsccommunity/DFSDsc/issues/96).
+  - Converted 'Ensure' parameters to default to 'Present' - fixes [Issue #29](https://github.com/dsccommunity/DFSDsc/issues/29).
+- DFSNamespaceFolder
+  - Added support for setting target referral status (TargetState) - fixes [Issue #96](https://github.com/dsccommunity/DFSDsc/issues/96).
+  - Converted 'Ensure' parameters to default to 'Present' - fixes [Issue #29](https://github.com/dsccommunity/DFSDsc/issues/29).
+- DFSReplicationGroup
+  - Converted 'Ensure' parameters to default to 'Present' - fixes [Issue #29](https://github.com/dsccommunity/DFSDsc/issues/29).
+- DFSReplicationGroupMember
+  - New module allowing replication group members to be separately defined outside of DFSReplicationGroup.
+    This allows situations where new memberships may be added separately on individual servers, instead of a single server.
+- DFSReplicationGroupConnection
+  - Add support for setting CrossFileRDCEnabled and MinimumRDCFileSizeInKB.
+  - Converted 'Ensure' parameters to default to 'Present' - fixes [Issue #29](https://github.com/dsccommunity/DFSDsc/issues/29).
+- DFSReplicationGroupFolder
+  - Allow Get-TargetResource and Test-TargetResource to run if group does not exist - fixes [Issue #125](https://github.com/dsccommunity/DFSDsc/issues/125).
+- DFSReplicationGroupMembership
+  - Add support for setting EnsureEnabled, MinimumFileStagingSize, ConflictAndDeletedQuotaInMB, RemoveDeletedFiles and DfsnPath.
+  - Allow Get-TargetResource and Test-TargetResource to run if group does not exist - fixes [Issue #125](https://github.com/dsccommunity/DFSDsc/issues/125).
 - BREAKING CHANGE: Changed resource prefix from MSFT to DSC.
 - Updated to use continuous delivery pattern using Azure DevOps - fixes
   [Issue #41](https://github.com/dsccommunity/DFSDsc/issues/98).
@@ -39,6 +58,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   images - Fixes [Issue #122](https://github.com/dsccommunity/DFSDsc/issues/122).
 - Updated pipeline unit tests and integration tests to use Windows Server 2019 and
   Windows Server 2022 images - Fixes [Issue #122](https://github.com/dsccommunity/DFSDsc/issues/122).
+- Temporarily pinned build image to Ubuntu 20.04 - Fixes [Issue #127](https://github.com/dsccommunity/DFSDsc/issues/127).
 
 ### Fixed
 

README.md

@@ -46,6 +46,8 @@ The **DFSDsc** module contains the following resources:
   Create, edit and remove DFS Replication Group connections.
 - **[DFSReplicationGroupFolder](https://github.com/PowerShell/DFSDsc/wiki/DFSReplicationGroupFolder)**:
   Configure DFS Replication Group folders.
+- **[DFSReplicationGroupMember](https://github.com/PowerShell/DFSDsc/wiki/DFSReplicationGroupMember)**:
+  Configure Replication Group Folder Members.
 - **[DFSReplicationGroupMembership](https://github.com/PowerShell/DFSDsc/wiki/DFSReplicationGroupMembership)**:
   Configure Replication Group Folder Membership.
 

azure-pipelines.yml

@@ -24,7 +24,7 @@ stages:
       - job: Package_Module
         displayName: 'Package Module'
         pool:
-          vmImage: 'ubuntu-latest'
+          vmImage: 'ubuntu-20.04'
         steps:
           - pwsh: |
               dotnet tool install --global GitVersion.Tool

source/DFSDsc.psd1

@@ -46,6 +46,7 @@
         'DFSReplicationGroup',
         'DFSReplicationGroupConnection',
         'DFSReplicationGroupFolder',
+        'DFSReplicationGroupMember',
         'DFSReplicationGroupMembership'
     )
 

source/DSCResources/DSC_DFSNamespaceFolder/DSC_DFSNamespaceFolder.psm1

@@ -18,6 +18,9 @@ $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'
 
     .PARAMETER Ensure
     Specifies if the DFS Namespace root should exist.
+
+    .PARAMETER TargetState
+    Specifies the state of the DFS namespace folder target.
 #>
 function Get-TargetResource
 {
@@ -33,10 +36,15 @@ function Get-TargetResource
         [System.String]
         $TargetPath,
 
-        [Parameter(Mandatory = $true)]
+        [Parameter()]
         [ValidateSet('Present','Absent')]
         [System.String]
-        $Ensure
+        $Ensure = 'Present',
+
+        [Parameter()]
+        [ValidateSet('Offline','Online')]
+        [System.String]
+        $TargetState = 'Online'
     )
 
     Write-Verbose -Message ( @(
@@ -96,6 +104,7 @@ function Get-TargetResource
         $returnValue += @{
             ReferralPriorityClass        = $targetFolder.ReferralPriorityClass
             ReferralPriorityRank         = $targetFolder.ReferralPriorityRank
+            TargetState                  = $targetFolder.State
         }
 
         Write-Verbose -Message ( @(
@@ -130,6 +139,9 @@ function Get-TargetResource
     .PARAMETER Ensure
     Specifies if the DFS Namespace root should exist.
 
+    .PARAMETER TargetState
+    Specifies the state of the DFS namespace folder target.
+
     .PARAMETER Description
     The description of the DFS Namespace.
 
@@ -161,10 +173,15 @@ function Set-TargetResource
         [System.String]
         $TargetPath,
 
-        [Parameter(Mandatory = $true)]
+        [Parameter()]
         [ValidateSet('Present','Absent')]
         [System.String]
-        $Ensure,
+        $Ensure = 'Present',
+
+        [Parameter()]
+        [ValidateSet('Offline','Online')]
+        [System.String]
+        $TargetState = 'Online',
 
         [Parameter()]
         [System.String]
@@ -212,7 +229,7 @@ function Set-TargetResource
 
             # The Folder properties that will be updated
             $folderProperties = @{
-                State = 'online'
+                State = 'Online'
             }
 
             if (($Description) `
@@ -280,6 +297,15 @@ function Set-TargetResource
             $targetProperties = @{}
 
             # Check the target properties
+            if (($TargetState) `
+                -and ($targetFolder.State -ne $TargetState))
+            {
+                $targetProperties += @{
+                    State = $TargetState
+                }
+                $targetChange = $true
+            }
+
             if (($ReferralPriorityClass) `
                 -and ($targetFolder.ReferralPriorityClass -ne $ReferralPriorityClass))
             {
@@ -399,6 +425,9 @@ function Set-TargetResource
     .PARAMETER Ensure
     Specifies if the DFS Namespace root should exist.
 
+    .PARAMETER TargetState
+    Specifies the state of the DFS namespace folder target.
+
     .PARAMETER Description
     The description of the DFS Namespace.
 
@@ -431,10 +460,15 @@ function Test-TargetResource
         [System.String]
         $TargetPath,
 
-        [Parameter(Mandatory = $true)]
+        [Parameter()]
         [ValidateSet('Present','Absent')]
         [System.String]
-        $Ensure,
+        $Ensure = 'Present',
+
+        [Parameter()]
+        [ValidateSet('Offline','Online')]
+        [System.String]
+        $TargetState = 'Online',
 
         [Parameter()]
         [System.String]
@@ -533,6 +567,17 @@ function Test-TargetResource
 
             if ($targetFolder)
             {
+                if (($TargetState) `
+                    -and ($targetFolder.State -ne $TargetState))
+                {
+                    Write-Verbose -Message ( @(
+                        "$($MyInvocation.MyCommand): "
+                        $($LocalizedData.NamespaceFolderTargetParameterNeedsUpdateMessage) `
+                            -f $Path,$TargetPath,'TargetState'
+                        ) -join '' )
+                    $desiredConfigurationMatch = $false
+                }
+
                 if (($ReferralPriorityClass) `
                     -and ($targetFolder.ReferralPriorityClass -ne $ReferralPriorityClass))
                 {

source/DSCResources/DSC_DFSNamespaceFolder/DSC_DFSNamespaceFolder.schema.mof

@@ -3,7 +3,8 @@ class DSC_DFSNamespaceFolder : OMI_BaseResource
 {
     [Key, Description("Specifies a path for the root of a DFS namespace.")] String Path;
     [Key, Description("Specifies a path for a root target of the DFS namespace.")] String TargetPath;
-    [Required, Description("Specifies if the DFS Namespace root should exist."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
+    [Write, Description("Specifies if the DFS Namespace root should exist."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
+    [Write, Description("Specifies the state of the DFS namespace folder target."), ValueMap{"Offline","Online"}, Values{"Offline","Online"}] String TargetState;
     [Write, Description("The description of the DFS Namespace.")] String Description;
     [Write, Description("Indicates whether a DFS namespace server provides a client only with referrals that are in the same site as the client.")] Boolean EnableInsiteReferrals;
     [Write, Description("Indicates whether a DFS namespace uses target failback.")] Boolean EnableTargetFailback;

source/DSCResources/DSC_DFSNamespaceRoot/DSC_DFSNamespaceRoot.psm1

@@ -19,6 +19,9 @@ $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'
     .PARAMETER Ensure
     Specifies if the DFS Namespace root should exist.
 
+    .PARAMETER TargetState
+    Specifies the state of the DFS namespace root target.
+
     .PARAMETER Type
     Specifies the type of a DFS namespace as a Type object.
 #>
@@ -36,10 +39,15 @@ function Get-TargetResource
         [System.String]
         $TargetPath,
 
-        [Parameter(Mandatory = $true)]
+        [Parameter()]
         [ValidateSet('Present','Absent')]
         [System.String]
-        $Ensure,
+        $Ensure = 'Present',
+
+        [Parameter()]
+        [ValidateSet('Offline','Online')]
+        [System.String]
+        $TargetState = 'Online',
 
         [Parameter(Mandatory = $true)]
         [ValidateSet('Standalone','DomainV1','DomainV2')]
@@ -108,6 +116,7 @@ function Get-TargetResource
         $returnValue += @{
             ReferralPriorityClass        = $target.ReferralPriorityClass
             ReferralPriorityRank         = $target.ReferralPriorityRank
+            TargetState                  = $target.State
         }
 
         Write-Verbose -Message ( @(
@@ -142,6 +151,9 @@ function Get-TargetResource
     .PARAMETER Ensure
     Specifies if the DFS Namespace root should exist.
 
+    .PARAMETER TargetState
+    Specifies the state of the DFS namespace root target.
+
     .PARAMETER Type
     Specifies the type of a DFS namespace as a Type object.
 
@@ -185,10 +197,15 @@ function Set-TargetResource
         [System.String]
         $TargetPath,
 
-        [Parameter(Mandatory = $true)]
+        [Parameter()]
         [ValidateSet('Present','Absent')]
         [System.String]
-        $Ensure,
+        $Ensure = 'Present',
+
+        [Parameter()]
+        [ValidateSet('Offline','Online')]
+        [System.String]
+        $TargetState = 'Online',
 
         [Parameter(Mandatory = $true)]
         [ValidateSet('Standalone','DomainV1','DomainV2')]
@@ -253,7 +270,7 @@ function Set-TargetResource
 
             # The root properties that will be updated
             $rootProperties = @{
-                State = 'online'
+                State = 'Online'
             }
 
             if (($Description) `
@@ -348,6 +365,15 @@ function Set-TargetResource
             $targetProperties = @{}
 
             # Check the target properties
+            if (($TargetState) `
+                -and ($target.State -ne $TargetState))
+            {
+                $targetProperties += @{
+                    State = $TargetState
+                }
+                $targetChange = $true
+            } # if
+
             if (($ReferralPriorityClass) `
                 -and ($target.ReferralPriorityClass -ne $ReferralPriorityClass))
             {
@@ -468,6 +494,9 @@ function Set-TargetResource
     .PARAMETER Ensure
     Specifies if the DFS Namespace root should exist.
 
+    .PARAMETER TargetState
+    Specifies the state of the DFS namespace root target.
+
     .PARAMETER Type
     Specifies the type of a DFS namespace as a Type object.
 
@@ -512,10 +541,15 @@ function Test-TargetResource
         [System.String]
         $TargetPath,
 
-        [Parameter(Mandatory = $true)]
+        [Parameter()]
         [ValidateSet('Present','Absent')]
         [System.String]
-        $Ensure,
+        $Ensure = 'Present',
+
+        [Parameter()]
+        [ValidateSet('Offline','Online')]
+        [System.String]
+        $TargetState = 'Online',
 
         [Parameter(Mandatory = $true)]
         [ValidateSet('Standalone','DomainV1','DomainV2')]
@@ -681,6 +715,17 @@ function Test-TargetResource
 
             if ($target)
             {
+                if (($TargetState) `
+                    -and ($target.State -ne $TargetState))
+                {
+                    Write-Verbose -Message ( @(
+                        "$($MyInvocation.MyCommand): "
+                        $($LocalizedData.NamespaceRootTargetParameterNeedsUpdateMessage) `
+                            -f $Type,$Path,$TargetPath,'TargetState'
+                        ) -join '' )
+                    $desiredConfigurationMatch = $false
+                } # if
+
                 if (($ReferralPriorityClass) `
                     -and ($target.ReferralPriorityClass -ne $ReferralPriorityClass))
                 {

source/DSCResources/DSC_DFSNamespaceRoot/DSC_DFSNamespaceRoot.schema.mof

@@ -3,7 +3,8 @@ class DSC_DFSNamespaceRoot : OMI_BaseResource
 {
     [Key, Description("Specifies a path for the root of a DFS namespace.")] String Path;
     [Key, Description("Specifies a path for a root target of the DFS namespace.")] String TargetPath;
-    [Required, Description("Specifies if the DFS Namespace root should exist."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
+    [Write, Description("Specifies if the DFS Namespace root should exist."), ValueMap{"Present","Absent"}, Values{"Present","Absent"}] String Ensure;
+    [Write, Description("Specifies the state of the DFS namespace root target."), ValueMap{"Offline","Online"}, Values{"Offline","Online"}] String TargetState;
     [Required, Description("Specifies the type of a DFS namespace as a Type object."), ValueMap{"Standalone","DomainV1","DomainV2"}, Values{"Standalone","DomainV1","DomainV2"}] String Type;
     [Write, Description("The description of the DFS Namespace.")] String Description;
     [Write, Description("Indicates whether a DFS namespace uses cost-based selection.")] Boolean EnableSiteCosting;