Resource Type: dsc_sqlserverendpoint

Defined in:

lib/puppet/type/dsc_sqlserverendpoint.rb

Providers:

powershell

Overview

The DSC SqlServerEndpoint resource type. Automatically generated from ‘SqlServerDsc/DSCResources/MSFT_SqlServerEndpoint/MSFT_SqlServerEndpoint.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_endpointname

  EndpointName - The name of the endpoint.

• dsc_ensure

  Ensure - If the endpoint should be present or absent. Default values is ‘Present’. Valid values are Present, Absent.

• dsc_instancename

  InstanceName - The name of the SQL instance to be configured.

• dsc_ipaddress

  IpAddress - The network IP address the endpoint is listening on. Default the endpoint will listen on any valid IP address.

• dsc_port

  Port - The network port the endpoint is listening on. Default value is 5022.

• dsc_psdscrunascredential

  PsDscRunAsCredential

• dsc_servername

  ServerName - The host name of the SQL Server to be configured. Default value is $env:COMPUTERNAME.

• name (namevar)
• provider

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