Resource Type: dsc_sqlalias

Defined in:

lib/puppet/type/dsc_sqlalias.rb

Providers:

powershell

Overview

The DSC SqlAlias resource type. Automatically generated from ‘SqlServerDsc/DSCResources/MSFT_SqlAlias/MSFT_SqlAlias.schema.mof’

To learn more about PowerShell Desired State Configuration, please visit technet.microsoft.com/en-us/library/dn249912.aspx.

For more information about built-in DSC Resources, please visit technet.microsoft.com/en-us/library/dn249921.aspx.

For more information about xDsc Resources, please visit github.com/PowerShell/DscResources.

Properties

• ensure

  The basic property that the resource should be in.

  Supported values:

  • exists?
  • present
  • absent

Parameters

• dsc_ensure

  Ensure - Determines whether the alias should be added or removed. Default value is ‘Present’ Valid values are Present, Absent.

• dsc_name

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

• dsc_pipename

  PipeName - Named Pipes path from the Get-TargetResource method.

• dsc_protocol

  Protocol - Protocol to use when connecting. Valid values are ‘TCP’ or ‘NP’ (Named Pipes). Default value is ‘TCP’. Valid values are TCP, NP.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_servername

  ServerName - The SQL Server you are aliasing (the NetBIOS name or FQDN).

• dsc_tcpport

  TcpPort - The TCP port SQL is listening on. Only used when protocol is set to ‘TCP’. Default value is port 1433.

• dsc_usedynamictcpport

  UseDynamicTcpPort - The UseDynamicTcpPort specify that the Net-Library will determine the port dynamically. The port specified in Port number will not be used. Default value is ‘$false’.

  Supported values:

  • true
  • false
• name (namevar)
• provider

  The specific backend to use for this ‘dsc_sqlalias` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.