DscPullServerSql.adoc

DSC Resource 'DscPullServerSql'

DscPullServerSql configures an OData endpoint for DSC service to make a node a DSC pull server.

Source	https://github.com/dsccommunity/CommonTasks/tree/dev/CommonTasks/DscResources/DscPullServerSql
DSC Resource	xPSDesiredStateConfiguration, PSDesiredStateConfiguration, xWebAdministration, File, NetworkingDsc
Documentation	xDscWebService, xWebConfigKeyValue, xWebAppPool, Firewall

Note	The IIS ApplicationPool PSWS to use for the Pull Server will be created.

Table 1. Attributes of category 'DscPullServerSql'

Parameter	Attribute	DataType	Description	Allowed Values
EndpointName	Key	String	The desired web service name.	Default: PSDSCPullServer
Port		Uint16	The port number of the DSC Pull Server IIS Endpoint.	Default: 8080
CertificateThumbPrint		String	The thumbprint of the Certificate in CERT:\LocalMachine\MY\ for creating the Pull Server HTTPS endpoint. Use AllowUnencryptedTraffic for setting up a non SSL based endpoint.	Default: AllowUnencryptedTraffic
RegistrationKey	Mandatory	String	DSC pull server registration key The key is stored in key file $env:PROGRAMFILES\WindowsPowerShell\DscService\RegistrationKeys.txt
SqlServer		String	Name of the SQL Server to host the DSC database	Default: localhost
DatabaseName		String	Name of the SQL Database for the Pull Server	Default: DSC
UseSecurityBestPractices		Boolean	This property will ensure that the Pull Server is created with the most secure practices.	False (default) True
ConfigureFirewall		Boolean	This property will ensure that a Firewall rule is created for Pull Server TCP Port.	False (default) True
PhysicalPath		String	The physical path for the IIS Endpoint on the machine (usually under inetpub).	Default: $env:SystemDrive\inetpub\PSDSCPullServer
ModulePath		String	The location on the disk where the Modules are stored.	Default: $env:PROGRAMFILES\WindowsPowerShell\DscService\Modules
ConfigurationPath		String	The location on the disk where the Configuration is stored.	Default: $env:PROGRAMFILES\WindowsPowerShell\DscService\Configuration

Example

DscPullServerSql:
  CertificateThumbPrint: AllowUnencryptedTraffic
  Port: 8080
  RegistrationKey: SomePass1
  SqlServer: SQL01
  DatabaseName: DSC
  EndpointName: PSDSCPullServer
  PhysicalPath: C:\inetpub\PSDSCPullServer
  ModulePath: C:\Program Files\WindowsPowerShell\DscService\Modules
  ConfigurationPath: C:\Program Files\WindowsPowerShell\DscService\Configuration
  UseSecurityBestPractices: True
  ConfigureFirewall: True