Skip to content

Latest commit

 

History

History
130 lines (98 loc) · 2.67 KB

SqlAliases.adoc

File metadata and controls

130 lines (98 loc) · 2.67 KB
Raw

DSC Resource 'SqlAliases'

SqlAliases manages the SQL Server Configuration Options on a SQL Server instance.

Source

DSC Resource

Documentation
Requirements

  • Target machine must be running Windows Server 2012 or later.

  • Target machine must be running SQL Server Database Engine 2012 or later.

Table 1. Attributes of category 'SqlAliases'
Parameter Attribute DataType Description Allowed Values

Values

Mandatory

Hashtable[]

List of SQL aliases.
Table 2. Attributes of category 'SqlAliases/Values'
Parameter Attribute DataType Description Allowed Values

Name

Key

String

The name of Alias (e.g. svr01\inst01).

Protocol

String

Protocol to use when connecting.

Valid values are TCP (TCP/IP) or NP (Named Pipes).

  • TCP (default)

  • NP

ServerName

String

The SQL Server you are aliasing.

This should be set to the NetBIOS name or fully qualified domain name (FQDN).

TcpPort

UInt16

The TCP port the SQL Server instance is listening on.

Only used when Protocol is set to TCP.

Default: 1433

UseDynamicTcpPort

Bool

Specifies that the Net-Library will determine the port dynamically.

The port number specified in Port will be ignored.

  • True

  • False (default)

Enure

String

Determines whether the alias should be added (Present) or removed (Absent).

  • Present (default)

  • Absent

PipeName

String

Returns the Named Pipes path if Protocol is set to NP.
Example
SqlConfiguration:
  Values:
    - ServerName        : SQL001.contoso.com
      Name              : SQLSERVER
      Protocol          : TCP
      UseDynamicTcpPort : true
      TcpPort           : false