From d0540f1e3784f2278b0ce790843689b437b34172 Mon Sep 17 00:00:00 2001 From: Johan Ljunggren Date: Fri, 26 Jun 2020 10:55:04 +0200 Subject: [PATCH] SqlAGReplica: Update documentation requirement (issue #1033) --- CHANGELOG.md | 5 ++++- source/DSCResources/DSC_SqlAGReplica/README.md | 7 +++++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 04a0ba4ad3..84eb4a795e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,7 +11,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Update resource parameter documentation ([issue #1568](https://github.com/dsccommunity/SqlServerDsc/issues/1568)). - Documentation is now published to the GitHub Wiki. - Update documentation around design pattern for Group Managed Service - Account ([issue #378](https://github.com/dsccommunity/SqlServerDsc/issues/378)) + Account ([issue #378](https://github.com/dsccommunity/SqlServerDsc/issues/378)). +- SqlAGReplica + - Update documentation with a requirement for SqlServer in certain circumstances + ([issue #1033](https://github.com/dsccommunity/SqlServerDsc/issues/1033)). ## [14.0.0] - 2020-06-12 diff --git a/source/DSCResources/DSC_SqlAGReplica/README.md b/source/DSCResources/DSC_SqlAGReplica/README.md index dfb2230d58..387c1d19fe 100644 --- a/source/DSCResources/DSC_SqlAGReplica/README.md +++ b/source/DSCResources/DSC_SqlAGReplica/README.md @@ -9,6 +9,13 @@ Always On Availability Group Replica. * Target machine must be running SQL Server Database Engine 2012 or later. * 'NT SERVICE\ClusSvc' or 'NT AUTHORITY\SYSTEM' must have the 'Connect SQL', 'Alter Any Availability Group', and 'View Server State' permissions. +* There are circumstances where the PowerShell module _SQLPS_ that is install + together with SQL Server does not work with all features of this resource. + The solution is to install the PowerShell module [_SqlServer_](https://www.powershellgallery.com/packages/SqlServer) + from the PowerShell Gallery. The module must be installed in a machine-wide + path of `env:PSModulePath` so it is found when LCM runs the DSC resource. + This will also make all SqlServerDsc DSC resources use the PowerShell + module _SqlServer_ instead of the PowerShell module _SQLPS_. ## Known issues