From c5dd2816421408211ca48e11bf9c2d1587f369f1 Mon Sep 17 00:00:00 2001 From: James Frierson <50841359+JamesFrierson1@users.noreply.github.com> Date: Thu, 27 Jun 2019 10:24:03 -0500 Subject: [PATCH] xActiveDirectory: Requirements section (#399) - Changes to xActiveDirectory - Added a Requirements section to every DSC resource README (issue #399). --- CHANGELOG.md | 6 ++++++ DSCResources/MSFT_xADDomain/README.md | 4 ++++ DSCResources/MSFT_xADDomainController/README.md | 4 ++++ DSCResources/MSFT_xADDomainDefaultPasswordPolicy/README.md | 4 ++++ DSCResources/MSFT_xADDomainTrust/README.md | 4 ++++ DSCResources/MSFT_xADForestProperties/README.md | 4 ++++ DSCResources/MSFT_xADGroup/README.md | 4 ++++ DSCResources/MSFT_xADKDSKey/README.md | 4 ++++ DSCResources/MSFT_xADManagedServiceAccount/README.md | 5 +++++ DSCResources/MSFT_xADObjectPermissionEntry/README.md | 4 ++++ DSCResources/MSFT_xADOrganizationalUnit/README.md | 4 ++++ DSCResources/MSFT_xADRecycleBin/README.md | 5 ++++- DSCResources/MSFT_xADReplicationSite/README.md | 4 ++++ DSCResources/MSFT_xADReplicationSiteLink/README.md | 4 ++++ DSCResources/MSFT_xADReplicationSubnet/README.md | 4 ++++ DSCResources/MSFT_xADServicePrincipalName/README.md | 4 ++++ DSCResources/MSFT_xADUser/README.md | 4 ++++ DSCResources/MSFT_xWaitForADDomain/README.md | 4 ++++ 18 files changed, 75 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3eb2a4a63..0e8727314 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,12 @@ ## Unreleased +- Changes to xActiveDirectory + - Added a Requirements section to every DSC resource README with the bullet point stating "Target machine must be running Windows Server 2008 R2 or later" ([issue #399](https://github.com/PowerShell/xActiveDirectory/pull/399)). + +- Changes to xADManagedServiceAccount + - Added a requirement to README stating "Group Managed Service Accounts need at least one Windows Server 2012 Domain Controller" ([issue #399](https://github.com/PowerShell/xActiveDirectory/pull/399)). + ## 3.0.0.0 - Changes to xActiveDirectory diff --git a/DSCResources/MSFT_xADDomain/README.md b/DSCResources/MSFT_xADDomain/README.md index b6fd6fc02..1f32426fd 100644 --- a/DSCResources/MSFT_xADDomain/README.md +++ b/DSCResources/MSFT_xADDomain/README.md @@ -1,3 +1,7 @@ # Description The xADDomain resource creates a new domain in a new forest or a child domain in an existing forest. While it is possible to set the forest functional level and the domain functional level during deployment with this resource the common restrictions apply. For more information see [TechNet](https://docs.microsoft.com/en-us/windows-server/identity/ad-ds/active-directory-functional-levels). + +## Requirements + +* Target machine must be running Windows Server 2008 R2 or later. diff --git a/DSCResources/MSFT_xADDomainController/README.md b/DSCResources/MSFT_xADDomainController/README.md index b65a6e878..ed865bf05 100644 --- a/DSCResources/MSFT_xADDomainController/README.md +++ b/DSCResources/MSFT_xADDomainController/README.md @@ -10,3 +10,7 @@ controllers in Active Directory. >information from another domain controller. >Make sure to use a correct domain account with the correct permission as >the account for the parameter `DomainAdministratorCredential`. + +## Requirements + +* Target machine must be running Windows Server 2008 R2 or later. diff --git a/DSCResources/MSFT_xADDomainDefaultPasswordPolicy/README.md b/DSCResources/MSFT_xADDomainDefaultPasswordPolicy/README.md index 134090555..b00b9fe8e 100644 --- a/DSCResources/MSFT_xADDomainDefaultPasswordPolicy/README.md +++ b/DSCResources/MSFT_xADDomainDefaultPasswordPolicy/README.md @@ -1,3 +1,7 @@ # Description The xADDomainDefaultPasswordPolicy DSC resource will manage an Active Directory domain's default password policy. + +## Requirements + +* Target machine must be running Windows Server 2008 R2 or later. diff --git a/DSCResources/MSFT_xADDomainTrust/README.md b/DSCResources/MSFT_xADDomainTrust/README.md index ad6727e08..4505d111a 100644 --- a/DSCResources/MSFT_xADDomainTrust/README.md +++ b/DSCResources/MSFT_xADDomainTrust/README.md @@ -1,3 +1,7 @@ # Description The xADDomainTrust DSC resource will manage Domain Trusts within Active Directory. A trust is a relationship, which you establish between domains, that makes it possible for users in one domain to be authenticated by a domain controller in the other domain. + +## Requirements + +* Target machine must be running Windows Server 2008 R2 or later. diff --git a/DSCResources/MSFT_xADForestProperties/README.md b/DSCResources/MSFT_xADForestProperties/README.md index 4b6148f25..546c1e6b8 100644 --- a/DSCResources/MSFT_xADForestProperties/README.md +++ b/DSCResources/MSFT_xADForestProperties/README.md @@ -1,3 +1,7 @@ # Description The xADForestProperties DSC resource will manage User Principal Name (UPN) suffixes and Service Principal Name (SPN) suffixes in a forest. + +## Requirements + +* Target machine must be running Windows Server 2008 R2 or later. diff --git a/DSCResources/MSFT_xADGroup/README.md b/DSCResources/MSFT_xADGroup/README.md index 61594dc1c..20ddd1779 100644 --- a/DSCResources/MSFT_xADGroup/README.md +++ b/DSCResources/MSFT_xADGroup/README.md @@ -1,3 +1,7 @@ # Description The xADGroup DSC resource will manage groups within Active Directory. + +## Requirements + +* Target machine must be running Windows Server 2008 R2 or later. diff --git a/DSCResources/MSFT_xADKDSKey/README.md b/DSCResources/MSFT_xADKDSKey/README.md index 082ff262c..25873edf4 100644 --- a/DSCResources/MSFT_xADKDSKey/README.md +++ b/DSCResources/MSFT_xADKDSKey/README.md @@ -1,3 +1,7 @@ # Description The xADKDSKey DSC resource will manage KDS Root Keys within Active Directory. The KDS root keys are used to begin generating Group Managed Service Account (gMSA) passwords. + +## Requirements + +* Target machine must be running Windows Server 2008 R2 or later. diff --git a/DSCResources/MSFT_xADManagedServiceAccount/README.md b/DSCResources/MSFT_xADManagedServiceAccount/README.md index b9db86088..0194eeb6b 100644 --- a/DSCResources/MSFT_xADManagedServiceAccount/README.md +++ b/DSCResources/MSFT_xADManagedServiceAccount/README.md @@ -2,3 +2,8 @@ The xADManagedServiceAccount DSC resource will manage Single and Group Managed Service Accounts (MSAs) within Active Directory. A Managed Service Account is a managed domain account that provides automatic password management, simplified service principal name (SPN) management and the ability to delegate management to other administrators. A Single Managed Service Account can only be used on a single computer, whereas a Group Managed Service Account can be shared across multiple computers. + +## Requirements + +* Target machine must be running Windows Server 2008 R2 or later. +* Group Managed Service Accounts need at least one Windows Server 2012 Domain Controller. diff --git a/DSCResources/MSFT_xADObjectPermissionEntry/README.md b/DSCResources/MSFT_xADObjectPermissionEntry/README.md index 78bc12e32..6d45c3916 100644 --- a/DSCResources/MSFT_xADObjectPermissionEntry/README.md +++ b/DSCResources/MSFT_xADObjectPermissionEntry/README.md @@ -4,3 +4,7 @@ The xADObjectPermissionEntry DSC resource will manage access control lists on Ac designed to to manage just one entry in the list of permissios (ACL) for one AD object. It will only interact with the one permission and leave all others as they were. The resource can be used multiple times to add multiple entries into one ACL. + +## Requirements + +* Target machine must be running Windows Server 2008 R2 or later. diff --git a/DSCResources/MSFT_xADOrganizationalUnit/README.md b/DSCResources/MSFT_xADOrganizationalUnit/README.md index ece8e438c..5e9a3d9b0 100644 --- a/DSCResources/MSFT_xADOrganizationalUnit/README.md +++ b/DSCResources/MSFT_xADOrganizationalUnit/README.md @@ -1,3 +1,7 @@ # Description The xADOrganizational Unit DSC resource will manage Organizational Units (OUs) within Active Directory. An OU is a subdivision within an Active Directory into which you can place users, groups, computers, and other organizational units. + +## Requirements + +* Target machine must be running Windows Server 2008 R2 or later. diff --git a/DSCResources/MSFT_xADRecycleBin/README.md b/DSCResources/MSFT_xADRecycleBin/README.md index 784abb8ab..ccfab56b5 100644 --- a/DSCResources/MSFT_xADRecycleBin/README.md +++ b/DSCResources/MSFT_xADRecycleBin/README.md @@ -4,4 +4,7 @@ The xADRecycleBin DSC resource will enable the Active Directory Recycle Bin feat This resource first verifies that the forest mode is Windows Server 2008 R2 or greater. If the forest mode is insufficient, then the resource will exit with an error message. The change is executed against the Domain Naming Master FSMO of the forest. -(Note: This resource is compatible with a Windows 2008 R2 or above target node.) + +## Requirements + +* Target machine must be running Windows Server 2008 R2 or later. diff --git a/DSCResources/MSFT_xADReplicationSite/README.md b/DSCResources/MSFT_xADReplicationSite/README.md index 3d243ea3a..456ae9f92 100644 --- a/DSCResources/MSFT_xADReplicationSite/README.md +++ b/DSCResources/MSFT_xADReplicationSite/README.md @@ -1,3 +1,7 @@ # Description The xADReplicationSite DSC resource will manage Replication Sites within Active Directory. Sites are used in Active Directory to either enable clients to discover network resources (published shares, domain controllers) close to the physical location of a client computer or to reduce network traffic over wide area network (WAN) links. Sites can also be used to optimize replication between domain controllers. + +## Requirements + +* Target machine must be running Windows Server 2008 R2 or later. diff --git a/DSCResources/MSFT_xADReplicationSiteLink/README.md b/DSCResources/MSFT_xADReplicationSiteLink/README.md index f4c703e03..2b24326f3 100644 --- a/DSCResources/MSFT_xADReplicationSiteLink/README.md +++ b/DSCResources/MSFT_xADReplicationSiteLink/README.md @@ -1,3 +1,7 @@ # Description The xADReplicationSiteLink DSC resource will manage Replication Site Links within Active Directory. A site link connects two or more sites. Site links reflect the administrative policy for how sites are to be interconnected and the methods used to transfer replication traffic. You must connect sites with site links so that domain controllers at each site can replicate Active Directory changes. + +## Requirements + +* Target machine must be running Windows Server 2008 R2 or later. diff --git a/DSCResources/MSFT_xADReplicationSubnet/README.md b/DSCResources/MSFT_xADReplicationSubnet/README.md index 2ea26f5d7..47002ef54 100644 --- a/DSCResources/MSFT_xADReplicationSubnet/README.md +++ b/DSCResources/MSFT_xADReplicationSubnet/README.md @@ -1,3 +1,7 @@ # Description The xADReplicationSubnet DSC resource will manage replication subnets. + +## Requirements + +* Target machine must be running Windows Server 2008 R2 or later. diff --git a/DSCResources/MSFT_xADServicePrincipalName/README.md b/DSCResources/MSFT_xADServicePrincipalName/README.md index 9a88fc099..df5b1bedd 100644 --- a/DSCResources/MSFT_xADServicePrincipalName/README.md +++ b/DSCResources/MSFT_xADServicePrincipalName/README.md @@ -1,3 +1,7 @@ # Description The xADServicePrincipalName DSC resource will manage service principal names. A service principal name (SPN) is a unique identifier of a service instance. SPNs are used by Kerberos authentication to associate a service instance with a service logon account. This allows a client application to request that the service authenticate an account even if the client does not have the account name. + +## Requirements + +* Target machine must be running Windows Server 2008 R2 or later. diff --git a/DSCResources/MSFT_xADUser/README.md b/DSCResources/MSFT_xADUser/README.md index 6341ddb42..dfdb065eb 100644 --- a/DSCResources/MSFT_xADUser/README.md +++ b/DSCResources/MSFT_xADUser/README.md @@ -1,3 +1,7 @@ # Description The xADUser DSC resource will manage Users within Active Directory. + +## Requirements + +* Target machine must be running Windows Server 2008 R2 or later. diff --git a/DSCResources/MSFT_xWaitForADDomain/README.md b/DSCResources/MSFT_xWaitForADDomain/README.md index 9f406e76a..c5d61873b 100644 --- a/DSCResources/MSFT_xWaitForADDomain/README.md +++ b/DSCResources/MSFT_xWaitForADDomain/README.md @@ -1,3 +1,7 @@ # Description The xWaitForADDomain resource is used to wait for Active Directory to become available. + +## Requirements + +* Target machine must be running Windows Server 2008 R2 or later.