ActiveDirectoryDsc

6.0.1-preview0001

The ActiveDirectoryDsc module contains DSC resources for deployment and configuration of Active Directory.

These DSC resources allow you to configure new domains, child domains, and high availability domain controllers, establish cross-domain trusts and manage users, groups and OUs.

Minimum PowerShell version

5.0

This is a prerelease version of ActiveDirectoryDsc.
There is a newer prerelease version of this module available.
See the version list below for details.

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name ActiveDirectoryDsc -RequiredVersion 6.0.1-preview0001 -AllowPrerelease

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name ActiveDirectoryDsc -Version 6.0.1-preview0001 -Prerelease

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

Copyright

Copyright the DSC Community contributors. All rights reserved.

Package Details

Author(s)

  • DSC Community

Tags

DesiredStateConfiguration DSC DSCResourceKit DSCResource

Functions

Find-DomainController

DSCResources

ADComputer ADDomain ADDomainController ADDomainControllerProperties ADDomainDefaultPasswordPolicy ADDomainFunctionalLevel ADDomainTrust ADForestFunctionalLevel ADForestProperties ADGroup ADKDSKey ADManagedServiceAccount ADObjectEnabledState ADObjectPermissionEntry ADOptionalFeature ADOrganizationalUnit ADReplicationSite ADReplicationSiteLink ADServicePrincipalName ADUser WaitForADDomain

Dependencies

This module has no dependencies.

Release Notes

# Change log for ActiveDirectoryDsc

The format is based on and uses the types of changes according to [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

For older change log history see the [historic changelog](HISTORIC_CHANGELOG.md).

## [Unreleased]

## [6.0.0] - 2020-03-12

### Added

- ActiveDirectoryDsc
 - Added [Codecov.io](https://codecov.io/) support.
 - Fixed miscellaneous spelling errors.
 - Added Strict-Mode v1.0 to all unit tests.
- ADDomain
 - Added integration tests
   ([issue #345](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/345)).
- ADGroup
 - Added support for Managed Service Accounts
   ([issue #532](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/532)).
- ADForestProperties
 - Added TombstoneLifetime property
   ([issue #302](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/302)).
 - Added Integration tests
   ([issue #349](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/349)).

### Fixed

- ADForestProperties
 - Fixed ability to clear `ServicePrincipalNameSuffix` and `UserPrincipalNameSuffix`
   ([issue #548](https://github.com/PowerShell/ActiveDirectoryDsc/issues/548)).
- WaitForADDomain
 - Fixed `Find-DomainController` to correctly handle an exception thrown when a domain controller is not ready
   ([issue #530](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/530)).
- ADObjectPermissionEntry
 - Fixed issue where Get-DscConfiguration / Test-DscConfiguration throw an exception when target object path does not
   yet exist
   ([issue #552](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/552)).
 - Fixed issue where Get-TargetResource throw an exception, `Cannot find drive. A drive with the name 'AD' does not
   exist`, when running soon after domain controller restart
   ([issue #547](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/547)).
- ADOrganizationalUnit
 - Fixed issue where Get-DscConfiguration/Test-DscConfiguration throws an exception when parent path does not yet exist
   ([issue #553](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/553)).
- ADReplicationSiteLink
 - Fixed issue creating a Site Link with options specified
   ([issue #571](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/571)).
- ADDomain
 - Added additional Get-ADDomain retry exceptions
   ([issue #574](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/574)).

### Changed

- ActiveDirectoryDsc
 - BREAKING CHANGE: Required PowerShell version increased from v4.0 to v5.0
 - Updated Azure Pipeline Windows image
   ([issue #551](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/551)).
 - Updated license copyright
   ([issue #550](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/550)).
- ADDomain
 - Changed Domain Install Tracking File to use NetLogon Registry Test.
   ([issue #560](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/560)).
 - Updated the Get-TargetResource function with the following:
   - Removed unused parameters.
   - Removed unnecessary domain membership check.
   - Removed unneeded catch exception blocks.
   - Changed Get-ADDomain and Get-ADForest to use localhost as the server.
   - Improved Try/Catch blocks to only cover cmdlet calls.
   - Simplified retry timing loop.
 - Refactored unit tests.
 - Updated NewChildDomain example to clarify the contents of the credential parameter and use Windows 2016 rather than
   2012 R2.
- ADDomainController
 - Updated the Get-TargetResource function with the following:
   - Removed unused parameters.
   - Added IsDnsServer read-only property
     ([issue #490](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/490)).
- ADForestProperties
 - Refactored unit tests.
- ADReplicationSiteLink
 - Refactored the `Set-TargetResource` function so that properties are only set if they have been changed.
 - Refactored the resource unit tests.
 - Added quotes to all the variables in the localised string data.
- ADOrganizationalUnit
 - Replaced throws with `New-InvalidOperationException`.
 - Refactored `Get-TargetResource` to not reference properties of a `$null` object
 - Fixed organization references to organizational.
 - Refactored `Test-TargetResource` to use `Compare-ResourcePropertyState` common function.
 - Reformatted code to keep line lengths to less than 120 characters.
 - Removed redundant `Assert-Module` and `Get-ADOrganizationalUnit` function calls from `Set-TargetResource`.
 - Wrapped `Set-ADOrganizationalUnit` and `Remove-ADOrganizationalUnit` with try/catch blocks and used common exception
   function.
 - Added `DistinguishedName` read-only property.
 - Refactored unit tests.
- ADUser
 - Improve Try/Catch blocks to only cover cmdlet calls.
 - Move the Test-Password function to the ActiveDirectoryDsc.Common module and add unit tests.
 - Reformat code to keep line lengths to less than 120 characters.
 - Fix Password parameter processing when PasswordNeverResets is $true.
 - Remove unnecessary Enabled parameter check.
 - Remove unnecessary Clear explicit parameter check.
 - Add check to only call Set-ADUser if there are properties to change.
 - Refactored Unit Tests - ([issue #467](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/467))

## [5.0.0] - 2020-01-14

### Added

- ADServicePrincipalName
 - Added Integration tests
   ([issue #358](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/358)).
- ADManagedServiceAccount
 - Added Integration tests.
- ADKDSKey
 - Added Integration tests
   ([issue #351](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/351)).

### Changed

- ADManagedServiceAccount
 - KerberosEncryptionType property added.
   ([issue #511](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/511)).
 - BREAKING CHANGE: AccountType parameter ValidateSet changed from ('Group', 'Single') to ('Group', 'Standalone') -
   Standalone is the correct terminology.
   Ref: [Service Accounts](https://docs.microsoft.com/en-us/windows/security/identity-protection/access-control/service-accounts).
   ([issue #515](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/515)).
 - BREAKING CHANGE: AccountType parameter default of Single removed. - Enforce positive choice of account type.
 - BREAKING CHANGE: MembershipAttribute parameter ValidateSet member SID changed to ObjectSid to match result property
   of Get-AdObject. Previous code does not work if SID is specified.
 - BREAKING CHANGE: AccountTypeForce parameter removed - unnecessary complication.
 - BREAKING CHANGE: Members parameter renamed to ManagedPasswordPrincipals - to closer match Get-AdServiceAccount result
   property PrincipalsAllowedToRetrieveManagedPassword. This is so that a DelegateToAccountPrincipals parameter can be
   added later.
 - Common Compare-ResourcePropertyState function used to replace function specific Compare-TargetResourceState and code
   refactored.
   ([issue #512](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/512)).
 - Resource unit tests refactored to use nested contexts and follow the logic of the module.
- ActiveDirectoryDsc
 - Updated PowerShell help files.
 - Updated Wiki link in README.md.
 - Remove verbose parameters from unit tests.
 - Fix PowerShell script file formatting and culture string alignment.
 - Add the `pipelineIndentationStyle` setting to the Visual Studio Code settings file.
 - Remove unused common function Test-DscParameterState
   ([issue #522](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/522)).

### Fixed

- ActiveDirectoryDsc
 - Fix tests ErrorAction on DscResource.Test Import-Module.
- ADObjectPermissionEntry
 - Updated Assert-ADPSDrive with PSProvider Checks
   ([issue #527](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/527)).
- ADReplicationSite
 - Fixed incorrect evaluation of site configuration state when no description is defined
   ([issue #534](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/534)).
- ADReplicationSiteLink
 - Fix RemovingSites verbose message
   ([issue #518](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/518)).
- ADComputer
 - Fixed the SamAcountName property description
   ([issue #529](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/529)).

## 4.2.0.0

### Added

- ADReplicationSite
 - Added 'Description' attribute parameter
   ([issue #500](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/500)).
 - Added Integration testing
   ([issue #355](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/355)).
- ADReplicationSubnet
 - Added 'Description' attribute parameter
   ([issue #503](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/500)).
 - Added Integration testing
   ([issue #357](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/357)).
- ADReplicationSiteLink
 - Added Integration testing
   ([issue #356](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/356)).
 - Added ability to set 'Options' such as Change Notification Replication
   ([issue #504](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/504)).

### Fixed

- ActiveDirectoryDsc
 - Resolved custom Script Analyzer rules that was added to the test framework.
- ActiveDirectoryDsc.Common
 - Fix `Test-DscPropertyState` Failing when Comparing $Null and Arrays.
   ([issue #513](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/513)).
- ADReplicationSite
 - Correct value returned for RenameDefaultFirstSiteName
   ([issue #502](https://github.com/dsccommunity/ActiveDirectoryDsc/issues/502)).

FileList

Version History

Version Downloads Last updated
6.6.0 65,169 9/29/2024
6.6.0-previe... 53 9/2/2024
6.5.1-previe... 44 8/19/2024
6.5.1-previe... 9 8/18/2024
6.5.0 57,490 5/17/2024
6.5.0-previe... 7 5/17/2024
6.4.1-previe... 82 4/8/2024
6.4.0 205,841 2/14/2024
6.4.0-previe... 10 2/14/2024
6.3.1-previe... 16 2/12/2024
6.3.0 382,045 8/24/2023
6.3.0-previe... 10 8/24/2023
6.3.0-previe... 2,708 5/26/2022
6.3.0-previe... 177 5/17/2022
6.2.0 3,637,521 5/1/2022
6.2.0-previe... 159 5/1/2022
6.2.0-previe... 157 5/1/2022
6.2.0-previe... 158 5/1/2022
6.2.0-previe... 164 4/30/2022
6.2.0-previe... 163 4/30/2022
6.2.0-previe... 2,448 1/24/2021
6.1.0-previe... 305,658 10/10/2020
6.1.0-previe... 636 7/13/2020
6.1.0-previe... 294 6/30/2020
6.1.0-previe... 194 6/23/2020
6.1.0-previe... 232 5/2/2020
6.1.0-previe... 191 5/2/2020
6.0.2-previe... 187 5/2/2020
6.0.2-previe... 202 4/27/2020
6.0.2-previe... 194 4/26/2020
6.0.2-previe... 193 4/25/2020
6.0.1 1,320,654 4/16/2020
6.0.1-previe... 199 4/9/2020
6.0.1-previe... (current version) 226 3/12/2020
6.0.0 10,069 3/12/2020
6.0.0-previe... 189 3/11/2020
6.0.0-previe... 190 3/10/2020
6.0.0-previe... 189 3/9/2020
6.0.0-previe... 189 3/9/2020
6.0.0-previe... 191 3/9/2020
6.0.0-previe... 189 3/9/2020
6.0.0-previe... 189 3/9/2020
6.0.0-previe... 195 2/28/2020
6.0.0-previe... 199 2/12/2020
5.1.0-previe... 194 2/10/2020
5.1.0-previe... 190 2/8/2020
5.1.0-previe... 192 2/7/2020
5.1.0-previe... 190 2/5/2020
5.1.0-previe... 195 1/20/2020
5.0.0 15,017 1/14/2020
5.0.0-previe... 190 1/14/2020
5.0.0-previe... 190 1/13/2020
5.0.0-previe... 189 1/12/2020
5.0.0-previe... 189 1/12/2020
5.0.0-previe... 189 1/12/2020
5.0.0-previe... 191 1/10/2020
4.2.0.0 20,891 10/30/2019
4.1.0.0 10,934 9/19/2019
4.0.0.0 9,105 8/8/2019
Show less