Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BREAKING CHANGE: SqlServerDsc: Remove SqlServerNetwork #1518

Merged
merged 3 commits into from
May 5, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ For older change log history see the [historic changelog](HISTORIC_CHANGELOG.md)

## [Unreleased]

### Removed

- SqlServerDsc
- BREAKING CHANGE: Removed resource _SqlServerNetwork_. The functionality
is now covered by the resources _SqlServerProtocol_ and _SqlServerProtocolTcpIp_.

### Added

- SqlServerDsc
Expand Down
46 changes: 0 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,6 @@ A full list of changes in each version can be found in the [change log](CHANGELO
* [**SqlServerMaxDop**](#sqlservermaxdop) resource to manage MaxDegree of Parallelism
for SQL Server.
* [**SqlServerMemory**](#sqlservermemory) resource to manage Memory for SQL Server.
* [**SqlServerNetwork**](#sqlservernetwork) resource to manage SQL Server Network
Protocols.
* [**SqlServerPermission**](#sqlserverpermission) Grant or revoke permission on
the SQL Server.
* [**SqlServerProtocol**](#sqlserverprotocol) resource manage the SQL Server
Expand Down Expand Up @@ -1576,50 +1574,6 @@ SQL Max Memory = TotalPhysicalMemory - (NumOfSQLThreads\*ThreadStackSize) -

All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/SqlServerDsc/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+SqlServerMemory).

### SqlServerNetwork

This resource is used to change the network settings for the instance.

Read more about the network settings in the article
[TCP/IP Properties (IP Addresses Tab)](https://docs.microsoft.com/en-us/sql/tools/configuration-manager/tcp-ip-properties-ip-addresses-tab).

>Note: Currently only TCP is supported.

#### Requirements

* Target machine must be running Windows Server 2008 R2 or later.
* Target machine must be running SQL Server Database Engine 2008 or later.

#### Parameters

* **`[String]` InstanceName** _(Key)_: The name of the SQL instance to be configured.
* **`[String]` ProtocolName** _(Required)_: The name of network protocol to be configured.
Only tcp is currently supported. { tcp }.
* **`[String]` ServerName** _(Write)_: The host name of the SQL Server to be configured.
Default value is $env:COMPUTERNAME.
* **`[Boolean]` IsEnabled** _(Write)_: Enables or disables the network protocol.
* **`[Boolean]` TcpDynamicPort** _(Write)_: Specifies whether the SQL Server
instance should use a dynamic port. Value cannot be set to $true if TcpPort
is set to a non-empty string.
* **`[String]` TcpPort** _(Write)_: The TCP port(s) that SQL Server should be listening
on. If the IP address should listen on more than one port, list all ports separated
with a comma ('1433,1500,1501'). To use this parameter set TcpDynamicPort to
$false.
* **`[Boolean]` RestartService** _(Write)_: If set to $true then SQL Server and
dependent services will be restarted if a change to the configuration is made.
The default value is $false.
* **`[Uint16]` RestartTimeout** _(Write)_: Timeout value for restarting the SQL Server
services. The default value is 120 seconds.

#### Examples

* [Enable TCP/IP with static port and restart SQL Server](/source/Examples/Resources/SqlServerNetwork/1-EnableTcpIpWithStaticPort.ps1)
* [Enable TCP/IP with dynamic port](/source/Examples/Resources/SqlServerNetwork/2-EnableTcpIpWithDynamicPort.ps1)

#### Known issues

All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/SqlServerDsc/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+SqlServerNetwork).

### SqlServerPermission

This resource sets server permissions to a user (login).
Expand Down
1 change: 0 additions & 1 deletion azure-pipelines.yml
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,6 @@ stages:
'tests/Integration/DSC_SqlSetup.Integration.Tests.ps1'
# Group 2
'tests/Integration/DSC_SqlAgentAlert.Integration.Tests.ps1'
'tests/Integration/DSC_SqlServerNetwork.Integration.Tests.ps1'
'tests/Integration/DSC_SqlServerLogin.Integration.Tests.ps1'
'tests/Integration/DSC_SqlServerEndPoint.Integration.Tests.ps1'
'tests/Integration/DSC_SqlServerDatabaseMail.Integration.Tests.ps1'
Expand Down
Loading