Version information
This version is compatible with:
- Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x
- Puppet >= 6.0.0 < 8.0.0
Start using this module
Add this module to your Puppetfile:
mod 'dsc-xsqlps', '1.2.0-0-1'
Learn more about managing modules with a PuppetfileDocumentation
Table of Contents
Description
This is an auto-generated module, using the Puppet DSC Builder to vendor and expose the PowerShell module's DSC resources as Puppet resources. The functionality of this module comes entirely from the vendored PowerShell resources, which are pinned at v1.2.0.0. The PowerShell module describes itself like this:
SQL module.
For information on troubleshooting to determine whether any encountered problems are with the Puppet wrapper or the DSC resource, see the troubleshooting section below.
Requirements
This module, like all auto-generated Puppetized DSC modules, relies on two important technologies in the Puppet stack: the Puppet Resource API and the puppetlabs/pwshlib Puppet module.
The Resource API provides a simplified option for writing types and providers and is responsible for how this module is structured. The Resource API ships inside of Puppet starting with version 6. While it is technically possible to add the Resource API functionality to Puppet 5.5.x, the DSC functionality has not been tested in this setup. For more information on the Resource API, review the documentation.
The module also depends on the pwshlib module. This Puppet module includes two important things: the ruby-pwsh library for running PowerShell code from ruby and the base provider for DSC resources, which this module leverages.
All of the actual work being done to call the DSC resources vendored with this module is in this file from the pwshlib module. This is important for troubleshooting and bug reporting, but doesn't impact your use of the module except that the end result will be that nothing works, as the dependency is not installed alongside this module!
Usage
You can specify any of the DSC resources from this module like a normal Puppet resource in your manifests. The examples below use DSC resources from from the PowerShellGet repository, regardless of what module you're looking at here; the syntax, not the specifics, is what's important.
For reference documentation about the DSC resources exposed in this module, see the Reference Forge tab, or the REFERENCE.md file.
# Include a meaningful title for your resource declaration
dsc_psrepository { 'Add team module repo':
dsc_name => 'foo',
dsc_ensure => present,
# This location is nonsense, can be any valid folder on your
# machine or in a share, any location the SourceLocation param
# for the DSC resource will accept.
dsc_sourcelocation => 'C:\Program Files',
# You must always pass an enum fully lower-cased;
# Puppet is case sensitive even when PowerShell isn't
dsc_installationpolicy => untrusted,
}
dsc_psrepository { 'Trust public gallery':
dsc_name => 'PSGallery',
dsc_ensure => present,
dsc_installationpolicy => trusted,
}
dsc_psmodule { 'Make Ruby manageable via uru':
dsc_name => 'RubyInstaller',
dsc_ensure => present,
}
For more information about using a built module, check out our narrative documentation.
Properties
Note that the only properties specified in a resource declaration which are passed to Invoke-Dsc are all prepended with dsc.
If a property does _not start with dsc_ it is used to control how Puppet interacts with DSC/other Puppet resources - for example,
specifying a unique name for the resource for Puppet to distinguish between declarations or Puppet metaparameters (notifies,
before, etc).
Troubleshooting
In general, there are three broad categories of problems:
- Problems with the way the underlying DSC resource works.
- Problems with the type definition, where you can't specify a valid set of properties for the DSC resource
- Problems with calling the underlying DSC resource - the parameters aren't being passed correctly or the resource can't be found
Unfortunately, problems with the way the underlying DSC resource works are something we can't help directly with. You'll need to file an issue with the upstream maintainers for the PowerShell module.
Problems with the type definition are when a value that should be valid according to the DSC resource's documentation and code is not accepted by the Puppet wrapper. If and when you run across one of these, please file an issue with the Puppet DSC Builder; this is where the conversion happens and once we know of a problem we can fix it and regenerate the Puppet modules. To help us identify the issue, please specify the DSC module, version, resource, property and values that are giving you issues. Once a fix is available we will regenerate and release updated versions of this Puppet wrapper.
Problems with calling the underlying DSC resource become apparent by comparing <value passed in in puppet>
with <value received by DSC>
.
In this case, please file an issue with the puppetlabs/pwshlib module, which is where the DSC base provider actually lives.
We'll investigate and prioritize a fix and update the puppetlabs/pwshlib module.
Updating to the pwshlib version with the fix will immediately take advantage of the improved functionality without waiting for this module to be reconverted and published.
For specific information on troubleshooting a generated module, check the troubleshooting guide for the puppet.dsc module.
Known Limitations
Currently, because of the way Puppet caches files on agents, use of the legacy puppetlabs-dsc
module is not compatible with this or any auto-generated DSC module.
Inclusion of both will lead to pluginsync conflicts.
Reference
Table of Contents
Resource types
dsc_xsqlalias
: The DSC xSqlAlias resource type. Automatically generated from version 1.2.0.0dsc_xsqlhaendpoint
: The DSC xSqlHAEndPoint resource type. Automatically generated from version 1.2.0.0dsc_xsqlhagroup
: The DSC xSqlHAGroup resource type. Automatically generated from version 1.2.0.0dsc_xsqlhaservice
: The DSC xSqlHAService resource type. Automatically generated from version 1.2.0.0dsc_xsqlserverinstall
: The DSC xSqlServerInstall resource type. Automatically generated from version 1.2.0.0dsc_xwaitforsqlhagroup
: The DSC xWaitForSqlHAGroup resource type. Automatically generated from version 1.2.0.0
Resource types
dsc_xsqlalias
The DSC xSqlAlias resource type. Automatically generated from version 1.2.0.0
Properties
The following properties are available in the dsc_xsqlalias
type.
dsc_ensure
Data type: Optional[Enum['Present', 'Absent']]
dsc_pipename
Data type: Optional[String]
dsc_protocol
Data type: Optional[Enum['TCP', 'NP']]
dsc_servername
Data type: Optional[String]
dsc_tcpport
Data type: Optional[Integer[-2147483648, 2147483647]]
Parameters
The following parameters are available in the dsc_xsqlalias
type.
dsc_name
namevar
Data type: String
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xsqlhaendpoint
The DSC xSqlHAEndPoint resource type. Automatically generated from version 1.2.0.0
Properties
The following properties are available in the dsc_xsqlhaendpoint
type.
dsc_alloweduser
Data type: String
Windows Account that could access the HA database mirroring endpoing.
dsc_portnumber
Data type: Optional[Integer[0, 4294967295]]
The single port number(nnnn) on which the Sql HA to listen to.
Parameters
The following parameters are available in the dsc_xsqlhaendpoint
type.
dsc_instancename
namevar
Data type: String
Name of Sql Instance.
dsc_name
namevar
Data type: String
Unique name for HA database mirroring endpoint of the sql instance.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xsqlhagroup
The DSC xSqlHAGroup resource type. Automatically generated from version 1.2.0.0
Properties
The following properties are available in the dsc_xsqlhagroup
type.
dsc_clustername
Data type: String
The name of windows failover cluster for the availability group
dsc_database
Data type: Array[String]
Array of databases on the local sql instance. Each database can belong to only one HA group.
dsc_databasebackuppath
Data type: String
The net share for Sql replication initialization
dsc_endpointname
Data type: String
Name of EndPoint to access High Availability sql instance.
dsc_instancename
Data type: String
Name of sql instance
Parameters
The following parameters are available in the dsc_xsqlhagroup
type.
dsc_domaincredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Domain credential could get list of cluster nodes.
dsc_name
namevar
Data type: String
The name of sql availability group
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_sqladministratorcredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Sql sa credential.
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xsqlhaservice
The DSC xSqlHAService resource type. Automatically generated from version 1.2.0.0
Parameters
The following parameters are available in the dsc_xsqlhaservice
type.
dsc_instancename
namevar
Data type: String
The name of Sql instance.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_servicecredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Domain credential to run sql service
dsc_sqladministratorcredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Sql sa credential
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xsqlserverinstall
The DSC xSqlServerInstall resource type. Automatically generated from version 1.2.0.0
Properties
The following properties are available in the dsc_xsqlserverinstall
type.
dsc_agentsvcaccount
Data type: Optional[String]
Specify the account for SQL server agent service.
dsc_features
Data type: Optional[String]
List of names of Sql Server features to install
dsc_installsqldatadir
Data type: Optional[String]
Specify the directory for SQL server system db files
dsc_sourcepath
Data type: String
The share path of sql server software.
dsc_sqlbackupdir
Data type: Optional[String]
Specify the directory for backup files.
dsc_sqlcollation
Data type: Optional[String]
Specify the default collation for SQL server
dsc_sqltempdbdir
Data type: Optional[String]
Specify the directory for TempDB files.
dsc_sqluserdbdir
Data type: Optional[String]
Specify the directory for UserDB data files.
dsc_sqluserdblogdir
Data type: Optional[String]
Specify the directory for UserDB log files.
dsc_svcaccount
Data type: Optional[String]
Specify the startup account for the SQL server service.
dsc_sysadminaccounts
Data type: Optional[String]
Specify logins to be members of the sysadmin role.
dsc_updateenabled
Data type: Optional[Boolean]
Specify whether SQL server setup should discover and include product updates.
dsc_versionid
Data type: Optional[String]
The numeric version identifier for the instance to be installed
Parameters
The following parameters are available in the dsc_xsqlserverinstall
type.
dsc_instancename
namevar
Data type: String
The name of sql instance.
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_sourcepathcredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
The credential that vm could use to access net share of sql server software.
dsc_sqladministratorcredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Sql sa credential
name
namevar
Data type: String
Description of the purpose for this resource declaration.
dsc_xwaitforsqlhagroup
The DSC xWaitForSqlHAGroup resource type. Automatically generated from version 1.2.0.0
Properties
The following properties are available in the dsc_xwaitforsqlhagroup
type.
dsc_clustername
Data type: String
The name of windows failover cluster for the availability group.
dsc_instancename
Data type: String
The name of sql instance.
dsc_retrycount
Data type: Optional[Integer[0, 4294967295]]
Maximum number of retries to check HA group existency
dsc_retryintervalsec
Data type: Optional[Integer[0, 18446744073709551615]]
Interval to check the HA group existency
Parameters
The following parameters are available in the dsc_xwaitforsqlhagroup
type.
dsc_domaincredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Domain credential could get list of cluster nodes.
dsc_name
namevar
Data type: String
The name of Sql High Availability group
dsc_psdscrunascredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
dsc_sqladministratorcredential
Data type: Optional[Struct[{ user => String[1], password => Sensitive[String[1]] }]]
Sql sa credential
name
namevar
Data type: String
Description of the purpose for this resource declaration.
Dependencies
- puppetlabs/pwshlib (>= 0.7.0 < 2.0.0)