Resource Type: dsc_sqlalias

Defined in:

lib/puppet/type/dsc_sqlalias.rb

Overview

The DSC SqlAlias resource type. Automatically generated from version 16.6.0

Properties

• dsc_ensure

  Determines whether the alias should be added (‘’Present’‘) or removed (`’Absent’‘). Default value is `’Present’‘.

• dsc_pipename

  Returns the _Named Pipes_ path if Protocol is set to ‘’NP’‘.

• dsc_protocol

  Protocol to use when connecting. Valid values are ‘’TCP’‘ (TCP/IP) or `’NP’‘ (_Named Pipes_). Default value is `’TCP’‘.

• dsc_servername

  The _SQL Server_ you are aliasing. This should be set to the NetBIOS name or fully qualified domain name (FQDN).

• dsc_tcpport

  The TCP port the _SQL Server_ instance is listening on. Only used when Protocol is set to ‘’TCP’‘. Default value is port `1433`.

• dsc_usedynamictcpport

  Specifies that the Net-Library will determine the port dynamically. The port number specified in Port will be ignored. Default value is ‘$false`.

Parameters

• dsc_name (namevar)

  The name of Alias (e.g. ‘’svr01inst01’‘).

• dsc_psdscrunascredential
• dsc_timeout

  The maximum time in seconds to wait for the DSC resource to complete.

• name (namevar)

  Description of the purpose for this resource declaration.

• validation_mode (defaults to: property)

  Whether to check if the resource is in the desired state by property (default) or using Invoke-DscResource in Test mode (resource).