sqlserver

Overview
Module Description - What the module does and why it is useful
Setup - The basics of getting started with sqlserver
- Setup requirements
- Beginning with sqlserver
Usage - Configuration options and additional functionality
Reference - An under-the-hood peek at what the module is doing and how
Limitations - OS compatibility, etc.
Development - Guide for contributing to the module

Overview

The sqlserver module installs and manages Microsoft SQL Server 2012, 2014, 2016 and 2017 on Windows systems.

Module Description

Microsoft SQL Server is a database platform for Windows. The sqlserver module lets you use Puppet to install multiple instances of SQL Server, add SQL features and client tools, execute TSQL statements, and manage databases, users, roles, and server configuration options.

Setup

Setup Requirements

The sqlserver module requires the following:

.NET 3.5. (Installed automatically if not present. This might require an internet connection.)
The contents of the SQL Server ISO file, mounted or extracted either locally or on a network share.
Windows Server 2012, 2012 R2, or 2016.

Beginning with sqlserver

To get started with the sqlserver module, include in your manifest:

sqlserver_instance{ 'MSSQLSERVER':
    features                => ['SQL'],
    source                  => 'E:/',
    sql_sysadmin_accounts   => ['myuser'],
}

This example installs MS SQL and creates an MS SQL instance named MSSQLSERVER. It also installs the base SQL feature set (Data Quality, FullText, Replication, and SQLEngine), specifies the location of the setup.exe, and creates a new SQL-only sysadmin, 'myuser'.

A more advanced configuration, including installer switches:

sqlserver_instance{ 'MSSQLSERVER':
  source                  => 'E:/',
  features                => ['SQL'],
  security_mode           => 'SQL',
  sa_pwd                  => 'p@ssw0rd!!',
  sql_sysadmin_accounts   => ['myuser'],
  install_switches        => {
    'TCPENABLED'          => 1,
    'SQLBACKUPDIR'        => 'C:\\MSSQLSERVER\\backupdir',
    'SQLTEMPDBDIR'        => 'C:\\MSSQLSERVER\\tempdbdir',
    'INSTALLSQLDATADIR'   => 'C:\\MSSQLSERVER\\datadir',
    'INSTANCEDIR'         => 'C:\\Program Files\\Microsoft SQL Server',
    'INSTALLSHAREDDIR'    => 'C:\\Program Files\\Microsoft SQL Server',
    'INSTALLSHAREDWOWDIR' => 'C:\\Program Files (x86)\\Microsoft SQL Server',
  }
}

This example creates the same MS SQL instance as shown above with additional options: security mode (requiring password to be set) and other optional install switches. This is specified using a hash syntax.

Usage

Note: For clarification on Microsoft SQL Server terminology, please see Microsoft SQL Server Terms below.

Install SQL Server tools and features not specific to a SQL Server instance

sqlserver_features { 'Generic Features':
  source   => 'E:/',
  features => ['ADV_SSMS', 'BC', 'Conn', 'SDK', 'SSMS'],
}

Create a new database on an instance of SQL Server

sqlserver::database{ 'minviable':
  instance => 'MSSQLSERVER',
}

Set up a new login

SQL Login
sqlserver::login{ 'vagrant':
  instance => 'MSSQLSERVER',
  password => 'Pupp3t1@',
}

# Windows Login
sqlserver::login{ 'WIN-D95P1A3V103\localAccount':
  instance   => 'MSSQLSERVER',
  login_type => 'WINDOWS_LOGIN',
}

Create a new login and a user for a given database

sqlserver::login{ 'loggingUser':
  password => 'Pupp3t1@',
}

sqlserver::user{ 'rp_logging-loggingUser':
  user     => 'loggingUser',
  database => 'rp_logging',
  require  => Sqlserver::Login['loggingUser'],
}

Manage the above user's permissions

sqlserver::user::permissions{'INSERT-loggingUser-On-rp_logging':
    user        => 'loggingUser',
    database    => 'rp_logging',
    permissions => 'INSERT',
    require     => Sqlserver::User['rp_logging-loggingUser'],
}

sqlserver::user::permissions{ 'Deny the Update as we should only insert':
  user        => 'loggingUser',
  database    => 'rp_logging',
  permissions => 'UPDATE',
  state       => 'DENY',
  require     => Sqlserver::User['rp_logging-loggingUser'],
}

Run custom TSQL statements

Use `sqlserver_tsql` to trigger other classes or defined types

sqlserver_tsql{ 'Query Logging DB Status':
  instance => 'MSSQLSERVER',
  onlyif   => "IF (SELECT count(*) FROM myDb.dbo.logging_table WHERE
      message like 'FATAL%') > 1000  THROW 50000, 'Fatal Exceptions in Logging', 10",
  notify   => Exec['Too Many Fatal Errors']
}

Clean up regular logs with conditional checks

sqlserver_tsql{ 'Cleanup Old Logs':
  instance => 'MSSQLSERVER',
  command  => "DELETE FROM myDb.dbo.logging_table WHERE log_date < '${log_max_date}'",
  onlyif   => "IF exists(SELECT * FROM myDb.dbo.logging_table WHERE log_date < '${log_max_date}')
      THROW 50000, 'need log cleanup', 10",
}

If you want your statement to always execute, leave out the `onlyif` parameter

sqlserver_tsql{ 'Always running':
  instance => 'MSSQLSERVER',
  command  => 'EXEC notified_executor()',
}

Advanced example

This advanced example:

Installs the basic SQL Server Engine from installation media mounted at 'D:' with TCP Enabled and various directories set.
Uses only Windows-based authentication and installs with only the user that Puppet is executing as. Note that the 'sql_sysadmin_accounts' is only applicable during the instance installation and is not actively enforced.
Creates a sqlserver::config resource, which is used in later resources to connect to the newly created instance. As we support only Windows-based authentication, a username and password is not required.
Creates a local group called 'DB Administrators' and ensures that it is SQL System Administrator (sysadmin role); also creates the account that Puppet uses to install and manage the instance.
Ensures that the advanced options for sp_configure are enabled, so that Puppet can manage the max memory setting for the instance.
Ensure that the max memory (MB) configuration item is set to 2048 megabytes.

$sourceloc = 'D:/'

# Install a SQL Server default instance
sqlserver_instance{'MSSQLSERVER':
  source                => $sourceloc,
  features              => ['SQLEngine'],
  sql_sysadmin_accounts => [$facts['id']],
  install_switches      => {
    'TCPENABLED'          => 1,
    'SQLBACKUPDIR'        => 'C:\\MSSQLSERVER\\backupdir',
    'SQLTEMPDBDIR'        => 'C:\\MSSQLSERVER\\tempdbdir',
    'INSTALLSQLDATADIR'   => 'C:\\MSSQLSERVER\\datadir',
    'INSTANCEDIR'         => 'C:\\Program Files\\Microsoft SQL Server',
    'INSTALLSHAREDDIR'    => 'C:\\Program Files\\Microsoft SQL Server',
    'INSTALLSHAREDWOWDIR' => 'C:\\Program Files (x86)\\Microsoft SQL Server'
  }
}

# Resource to connect to the DB instance
sqlserver::config { 'MSSQLSERVER':
  admin_login_type => 'WINDOWS_LOGIN'
}

# Enforce SQL Server Administrators
$local_dba_group_name = 'DB Administrators'
$local_dba_group_netbios_name = "${facts['hostname']}\\DB Administrators"

group { $local_dba_group_name:
  ensure => present
}

-> sqlserver::login { $local_dba_group_netbios_name :
  login_type  => 'WINDOWS_LOGIN',
}

-> sqlserver::role { 'sysadmin':
  ensure   => 'present',
  instance => 'MSSQLSERVER',
  type     => 'SERVER',
  members  => [$local_dba_group_netbios_name, $facts['id']],
}

# Enforce memory consumption
sqlserver_tsql {'check advanced sp_configure':
  command => 'EXEC sp_configure \'show advanced option\', \'1\'; RECONFIGURE;',
  onlyif => 'sp_configure @configname=\'max server memory (MB)\'',
  instance => 'MSSQLSERVER'
}

-> sqlserver::sp_configure { 'MSSQLSERVER-max memory':
  config_name => 'max server memory (MB)',
  instance => 'MSSQLSERVER',
  reconfigure => true,
  restart => true,
  value => 2048
}

Reference

Types

Parameters are optional unless otherwise noted.

`sqlserver_features`

Installs and configures features such as SSMS and Master Data Service.

`ensure`

Specifies whether the managed features should exist. Valid options: 'present' and 'absent'.

Default: 'present'.

`features`

Required.

Specifies one or more features to manage. Valid options: 'BC', 'Conn', 'SSMS', 'ADV_SSMS', 'SDK', 'IS', 'MDS', 'BOL', 'DREPLAY_CTLR', 'DREPLAY_CLT'.

The 'Tools' value for this setting is deprecated. Specify 'BC', 'SSMS', 'ADV_SSMS', 'Conn', and 'SDK' explicitly.

`install_switches`

Passes one or more installer switches to SQL Server Setup. If an option is set in both its own specific parameter and install_switches, the specifically named parameter takes precedence. For example, if you set the product key in both pid and in install_switches, SQL Server honors the pid parameter. Valid options: an array.

Note: If an option is set in both its own specific parameter and install_switches, the specifically named parameter takes precedence. For example, if you set the product key in both pid and in install_switches, SQL Server honors the pid parameter.

For more information about installer switches and configuring SQL Server, see the links below:

Installer Switches

Configuration File

Default: {}.

`is_svc_account`

Specifies a domain or system account to be used by Integration Services. Valid options: a string specifying an existing username. Default: 'NT AUTHORITY\NETWORK SERVICE'.

`is_svc_password`

Required if is_svc_account points to a domain account. Invalid for system accounts.

Supplies the password for the Integration Services user account. Valid options: a string specifying a valid password.

`pid`

Specifies a product key for SQL Server. Valid options: a string containing a valid product key. If not specified, SQL Server runs in Evaluation mode.

Default: undef.

`source`

Required.

Locates the SQL Server installer. Valid options: a string containing the path to an executable. Puppet must have permission to execute the installer.

`windows_feature_source`

Specifies the location of the Windows Feature source files. You might need this to install the .Net Framework. See https://support.microsoft.com/en-us/kb/2734782 for more information.

`sqlserver_instance`

Installs and configures a SQL Server instance.

`agt_svc_account`

Specifies a domain or system account to be used by the SQL Server Agent service.

Valid options: a string specifying an existing username.

`agt_svc_password`

Required if agt_svc_account points to a domain account. Invalid for system accounts.

Supplies the password for the Agent service's user account.

Valid options: a string specifying a valid password.

`as_svc_account`

Specifies a domain or system account to be used by Analysis Services.

Valid options: a string specifying an existing username.

`as_svc_password`

Required if as_svc_account is specified.

Supplies the password for the Analysis Services user account.

Valid options: a string specifying a valid password.

`as_sysadmin_accounts`

Required if your features array includes the value 'AS'.

Specifies one or more SQL or domain accounts to receive sysadmin status.

Valid options: an array specifying one or more valid usernames.

`ensure`

Specifies whether the managed instance should exist. Valid options: 'present' and 'absent'.

Default: 'present'.

`features`

Required. Specifies one or more features to manage. The list of top-level features includes 'AS' and 'RS'. Valid options: an array containing one or more of the strings 'SQL', 'SQLEngine', 'Replication', 'FullText', 'DQ', 'AS', 'RS', 'POLYBASE', and 'ADVANCEDANALYTICS'.

The 'SQL' value for this setting is deprecated. Specify 'DQ', 'FullText', 'Replication', and 'SQLEngine' explicitly.

`install_switches`

Passes one or more extra installer switches to SQL Server Instance Setup. Valid options: a hash of installer switches.

Note: If an option is set in both its own specific parameter and install_switches, the specifically named parameter takes precedence. For example, if you set the product key in both pid and in install_switches, SQL Server honors the pid parameter.

For more information about installer switches and configuring SQL Server, see the links below:

Installer Switches

Configuration File

`name`

Supplies a name for the instance. Valid options: a string containing a valid instance name.

Default: the existing title of your declared resource.

`pid`

Specifies a product key for SQL Server. Valid options: a string containing a valid product key. If not specified, SQL Server runs in Evaluation mode.

Default: undef.

`polybase_svc_account`

Applicable only if the POLYBASE feature for SQL Server 2016 is being installed.

Specifies a domain or system account for the Polybase Engine service.

Valid options: a string specifying an existing username.

`polybase_svc_password`

Applicable only if the POLYBASE feature for SQL Server 2016 is being installed.

Specifies the password for the Polybase Engine service

Valid options: a string specifying a valid password.

`rs_svc_account`

Specifies a domain or system account to be used by the report service. Valid options: a string; cannot include any of the following characters: '"/ \ [ ] : ; | = , + * ? < >'. If you specify a domain user account, the domain must be less than 254 characters and the username must be less than 20 characters.

Default: Default built-in account for the current operating system (either NetworkService or LocalSystem).

`rs_svc_password`

Required if rs_svc_account points to a domain account. Invalid for system accounts.

Supplies the password for the report server's user account. Valid options: a string containing a strong password (at least 8 characters, including uppercase and lowercase alphanumeric characters and at least one symbol character. Avoid words or names that might be listed in a dictionary).

`sa_pwd`

Required if security_mode is set to 'SQL'.

Sets a password for the SQL Server sa account. Valid options: a string specifying a valid password.

`security_mode`

Specifies a security mode for SQL Server. Valid options: 'SQL'. If not specified, SQL Server uses Windows authentication.

Default: undef.

`source`

Required.

Locates the SQL Server installer. Valid options: a string containing the path to an executable. Puppet must have permission to execute the installer.

`sql_svc_account`

Specifies a domain or system account to be used by the SQL Server service. Valid options: a string specifying an existing username.

Default: undef.

`sql_svc_password`

Required if sql_svc_account points to a domain account. Invalid for system accounts.

Supplies the password for the SQL Server service's user account. Valid options: a string specifying a valid password.

`sql_sysadmin_accounts`

Required.

Specifies one or more SQL or system accounts to receive sysadmin status. Valid options: an array specifying one or more valid usernames.

`windows_feature_source`

Specifies the location of the Windows Feature source files. This may be needed to install the .Net Framework. See https://support.microsoft.com/en-us/kb/2734782 for more information.

`sqlserver_tsql`

Executes a TSQL query against a SQL Server instance.

Requires the sqlserver::config defined type for access to the parent instance.

`command`

Supplies a TSQL statement to execute. Valid options: a string.

`instance`

Required.

Specifies the SQL Server instance on which to execute the statement. Valid options: a string containing the name of an existing instance.

Default: 'MSSQLSERVER'.

`database`

Specifies the default database to connect to. Default: 'master'

`onlyif`

Supplies a TSQL statement to execute before running the command statement, determining whether to move forward. If the onlyif statement ends with a THROW or any non-standard exit, Puppet executes the command statement. Valid options: a string.

Defined Types

Parameters are optional unless otherwise noted.

`sqlserver::config`

Stores credentials for Puppet to use when managing a given SQL Server instance.

`admin_login_type`

Specifies the type of login used to manage to SQL Server instance. The login type affects the admin_user and admin_pass parameters which are described below. Valid options: 'SQL_LOGIN' and 'WINDOWS_LOGIN'.

Default: 'SQL_LOGIN'.

When using SQL Server based authentication - SQL_LOGIN
- admin_pass: Required. Supplies the password for the specified admin_user account. Valid options: a string specifying a valid password.
- admin_user: Required. Specifies a login account with sysadmin rights on the server, to be used for managing the instance. Valid options: a string containing a username.
When using Windows based authentication - WINDOWS_LOGIN
- admin_pass: Valid options: undefined or an empty string ''
- admin_user: Valid options: undefined or an empty string ''

`instance_name`

Specifies a SQL Server instance to manage. Valid options: a string containing the name of an existing instance.

Default: the title of your declared resource.

`sqlserver::database`

Creates and configures a database within a given SQL Server instance.

Requires the sqlserver::config defined type for access to the parent instance.

`collation_name`

Specifies a dictionary on which to base the database's default sort order. Valid options: to find out what values your system supports, run the query SELECT * FROM sys.fn_helpcollations() WHERE name LIKE 'SQL%'.

Default: undef.

`compatibility`:

Specifies the version(s) of SQL Server with which the database should be compatible. Valid options: a compatibility level number (for example, 100 for SQL Server 2008 through SQL Server 2014). For a complete list of values, see the SQL Server documentation.

`containment`

Sets the database's containment type. For details on containment, see the SQL Server documentation. Valid options: 'NONE' and 'PARTIAL' ('PARTIAL' requires the sqlserver::sp_configure defined type).

Default: 'NONE'.

`db_chaining`

Determines whether the managed database can be the source or target of a cross-database ownership chain. Only applicable if containment is set to 'PARTIAL'. Valid options: 'ON' and 'OFF'.

Default: 'OFF'.

`db_name`: Required.

Specifies a database to manage. Valid options: a string containing the name of the database.

Default: the title of your declared resource.

`default_fulltext_language`

Sets the default fulltext language. Only applicable if containment is set to 'PARTIAL'. Valid options: see the SQL Server documentation.

Default: 'English'.

`default_language`

Sets the default language. Only applicable if containment is set to 'PARTIAL'. Valid options: see the SQL Server documentation.

Default: 'us_english'.

`ensure`

Specifies whether the managed database should exist. Valid options: 'present' and 'absent'.

Default: 'present'.

`filespec_filegrowth`

Specifies the automatic growth increment of the filespec file. Cannot be specified if os_file_name is set to a UNC path. This parameter is set at creation only; it is not affected by updates. Valid options: a number, with an optional suffix of 'KB', 'MB', 'GB', or 'TB', no greater than the value of filespec_maxsize. If you do not include a suffix, SQL Server assumes the number is in megabytes.

Default: undef.

`filespec_filename`

Required if filespec_name is specified.

Specifies the operating system (physical) name of the filespec file. This parameter is set at creation only; it is not affected by updates. Valid options: a string containing an absolute path.

Default: undef.

`filespec_maxsize`

Specifies the maximum size to which the filespec file can grow. Cannot be specified if os_file_name is set to a UNC path. This parameter is set at creation only; it is not affected by updates. Valid options: a number, no greater than 2147483647, with an optional suffix of 'KB', 'MB', 'GB', or 'TB'. If you do not include a suffix, SQL Server assumes the number is in megabytes.

Default: undef.

`filespec_name`

Required if filespec_filename is specified.

Specifies the logical name of the filespec object within the SQL Server instance. This parameter is set at creation only; it is not affected by updates. Valid options: a string. Must be unique to the instance.

Default: undef.

`filespec_size`

Specifies the size of the filespec file. This parameter is set at creation only; it is not affected by updates. Valid options: a number, no greater than 2147483647, with an optional suffix of 'KB', 'MB', 'GB', or 'TB'. If you do not include a suffix, SQL Server assumes the number is in megabytes.

Default: undef.

`filestream_directory_name`

Specifies a directory in which to store filestream data. You must set this option before creating a FileTable in the database. This parameter is set at creation only; it is not affected by updates. Requires the sqlserver::sp_configure defined type. Valid options: a string containing a Windows-compatible directory name. This name must be unique among all the Database_Directory names in the SQL Server instance. Uniqueness comparison is case-insensitive, regardless of SQL Server collation settings.

Default: undef.

`filestream_non_transacted_access`

Specifies the level of non-transactional FILESTREAM access to the database. This parameter is set at creation only; it is not affected by updates. Requires the sqlserver::sp_configure defined type. Valid options: 'OFF', 'READ_ONLY', and 'FULL'.

Default: undef.

`instance`

Specifies a SQL Server instance on which to manage the database. Valid options: a string containing the name of an existing instance.

Default: 'MSSQLSERVER'.

`log_filegrowth`

Specifies the automatic growth increment of the log file. Cannot be specified if os_file_name is set to a UNC path. Does not apply to a FILESTREAM filegroup. This parameter is set at creation only; it is not affected by updates. Valid options: a number with an optional suffix of 'KB', 'MB', 'GB', or 'TB', no greater than the value of log_maxsize. If you do not include a suffix, SQL Server assumes the number is in megabytes.

Default: undef.

`log_filename`

Required if log_name is specified.

Specifies the operating system (physical) name of the log file. This parameter is set at creation only; it is not affected by updates. Valid options: a string containing an absolute path.

Default: undef.

`log_maxsize`

Specifies the maximum size to which the log file can grow. Cannot be specified if os_file_name is set to a UNC path. This parameter is set at creation only; it is not affected by updates. Valid options: a number, no greater than 2147483647, with an optional suffix of 'KB', 'MB', 'GB', or 'TB'. If you do not include a suffix, SQL Server assumes the number is in megabytes.

Default: undef.

`log_name`

Required if log_filename is specified.

Specifies the logical name of the log object within SQL Server. This parameter is set at creation only; it is not affected by updates. Valid options: a string.

Default: undef.

`log_size`

Specifies the size of the file. This parameter is set at creation only; it is not affected by updates. Valid options: a number, no greater than 2147483647, with an optional suffix of 'KB', 'MB', 'GB', or 'TB'. If you do not include a suffix, SQL Server assumes the number is in megabytes.

Default: undef.

`nested_triggers`

Specifies whether to enable cascading triggers. Only applicable if containment is set to 'PARTIAL'. For more about nested triggers, see the SQL Server documentation. Valid options: 'ON' and 'OFF'.

Default: undef.

`transform_noise_words`

Specifies whether to remove noise or stop words, such as "is", "the", "this". Only applicable if containment is set to 'PARTIAL'. Valid options: 'ON' and 'OFF'.

Default: undef.

`trustworthy`

Determines whether database modules (such as views, user-defined functions, or stored procedures) that use an impersonation context can access resources outside the database. Only applicable if containment is set to 'PARTIAL'. Valid options: 'ON' and 'OFF'.

Default: 'OFF'.

`two_digit_year_cutoff`

Sets the year at which the system will treat the year as four digits instead of two. For example, if set to '1999', 1998 is abbreviated to '98' and 2014 is abbreviated to '2014'. Only applicable if containment is set to 'PARTIAL'. Valid options: any year between 1753 and 9999.

Default: 2049.

For more information about these settings in SQL Server, please see:

Contained Databases

Create Database TSQL

Alter Database TSQL

System Languages

FILESTREAM usage might require some manual configuration of SQL Server. Please see Enable and Configure FILESTREAM for details.

`sqlserver::login`

Requires the sqlserver::config defined type.

`check_expiration`:

Specifies whether SQL Server should prompt the user to change their password if it has expired. Only applicable if login_type is set to 'SQL_LOGIN'. Valid options: true and false.

Default: false.

`check_policy`

Specifies whether to enforce the password policy. Only applicable if login_type is set to 'SQL_LOGIN'. Valid options: true and false.

Default: true.

`default_database`

Specifies a database for the login to connect to by default. Valid options: a string containing the name of an existing database.

Default: 'master'.

`default_language`

Specifies a default language. Valid options: see the SQL Server documentation.

Default: 'us_english'.

`disabled`

Specifies whether the managed login should be disabled. Valid options: true and false.

Default: false.

`ensure`

Specifies whether the managed login should exist. Valid options: 'present' and 'absent'.

Default: 'present'.

`instance`

Specifies a SQL Server instance on which to manage the login. Valid options: a string containing the name of an existing instance.

Default: 'MSSQLSERVER'.

`login`

Required.

Specifies a Windows or SQL login to manage. Valid options: a string containing an existing login.

`login_type`

Specifies the type of login to use. Valid options: 'SQL_LOGIN' and 'WINDOWS_LOGIN'.

Default: 'SQL_LOGIN'.

`password`

Required if login_type is set to 'SQL_LOGIN'.

Sets a password for the managed login. Valid options: a string.

`svrroles`

Assigns one or more pre-installed server roles to the login. Valid options: a hash of permission => value pairs, where a value of 0 means disabled and a value of 1 means enabled. For example, {'diskadmin' => 1, 'dbcreator' => 1, 'sysadmin' => 0}. For a complete list of valid permissions, see the SQL Server documentation.

For more information about these settings in SQL Server, please see:

Server Role Members

Create Login

Alter Login

`sqlserver::login::permissions`

Configures the permissions associated with a given login account.

`instance`

Specifies a SQL Server instance on which to manage the permissions. Valid options: a string containing the name of an existing instance.

Default: 'MSSQLSERVER'.

`login`

Required.

Specifies a SQL or Windows login to manage. Valid options: a string containing an existing login.

`permissions`

Required.

Specifies one or more permissions to manage. Valid options: a string or an array of strings, where each string contains a SQL Server permissions (for example, 'SELECT', 'INSERT', 'UPDATE', or 'DELETE').

`state`

Determines the state of the specified permissions. Valid options: 'GRANT', 'DENY', and 'REVOKE'. If set to 'REVOKE', Puppet removes any explicit statements of these permissions and falls back on inherited levels.

Default: 'GRANT'.

`with_grant_option`

Determines whether the account can grant these permissions to others. Valid options: true and false.

Default: false.

`sqlserver::user`

Creates and configures a user account within a given database.

Requires the sqlserver::config defined type for access to the parent instance.

`database`

Required.

Specifies the database in which to manage the user. Valid options: a string containing the name of an existing database.

`default_schema`

Specifies a SQL schema or namespace for the user to connect to by default. Valid options: a string.

Default: 'dbo' unless changed at the server level.

`ensure`

Specifies whether the managed user should exist. Valid options: 'present' and 'absent'.

Default: 'present'.

`instance`

Specifies a SQL Server instance on which to manage the user. Valid options: a string containing the name of an existing instance.

Default: 'MSSQLSERVER'.

`login`

Associates the user with a login. Valid options: a string containing an existing login. If not specified, SQL Server assumes the username and login are the same.

Default: undef.

`password`

Assigns a password to the user. Only valid if the database's containment parameter is set to 'PARTIAL'. Valid options: a string specifying a valid password.

`user`

Required.

Specifies a user to manage. Valid options: a string containing a username.

Default: the title of your declared resource.

`sqlserver::user::permissions`

Configures the permissions associated with a user account within a given database.

Requires the sqlserver::config defined type for access to the parent instance.

`database`

Required.

Specifies the database in which to manage the user's permissions. Valid options: a string containing the name of an existing database.

`instance`

Specifies the SQL Server instance on which the user and database exist. Valid options: a string containing the name of an existing instance.

Default: 'MSSQLSERVER'.

`permissions`

Required.

Specifies one or more permissions to manage. Valid options: an array containing one or more SQL Server permissions formatted as strings (for example, ['SELECT', 'INSERT', 'UPDATE', 'DELETE']).

`state`

Determines the state of the specified permissions. Valid options: 'GRANT', 'DENY', and 'REVOKE'. If set to 'REVOKE', Puppet removes any explicit statements of these permissions and falls back on inherited levels.

Default: 'GRANT'.

`user`

Required.

Specifies which user's permissions to manage. Valid options: a string containing a username.

Default: the title of your declared resource.

`with_grant_option`

Determines whether the affected user can grant these permissions to others. Valid options: true and false.

Default: false.

For more information about these settings and permissions in SQL Server, please see:

Permissions (Database Engine)

Grant Database Permissions

`sqlserver::role`

Creates and configures a server-wide or database-specific role.

Requires the sqlserver::config defined type for access to the parent instance.

`authorization`

Sets the role's owner. Valid options: a string containing an existing login or username.

Default: the value of user in the corresponding sqlserver::config resource.

`database`

Specifies the database on which to create the role. Only valid if type is set to 'DATABASE'. Valid options: a string specifying the name of an existing database.

Default: 'master'.

`ensure`

Specifies whether the managed role should exist. Valid options: 'absent' and 'present'.

Default: 'present'.

`instance`

Specifies a SQL Server instance on which to manage the role. Valid options: a string containing the name of an existing instance.

Default: 'MSSQLSERVER'.

`members`

Assigns one or more members to the role. Valid options: an array of one or more logins and/or usernames.

Default: {}.

`members_purge`

Specifies whether to drop any existing members of the role that are not explicitly included in the members parameter. Use with caution. If set to true and members is an empty array, Puppet drops all members from the role. Valid options: true and false.

Default: false.

`permissions`

Required.

Associates one or more permissions with the role. Valid options: a hash of one or more key => value pairs, where each key is the desired permission state and each value is an array of strings specifying the permissions to be managed.

Valid hash keys:

'GRANT'
'GRANT_WITH_OPTION' (lets the user grant this permission to others)
'DENY'
'REVOKE' (removes any explicit statements of this permission and falls back on inherited levels)

Valid hash values: An array of one or more strings containing SQL Server permissions.

Example: {'GRANT' => ['CONNECT', 'CREATE ANY DATABASE'] }

`role`

Sets the role's name. Valid options: a string. Must be unique to the instance.

Default: the title of your declared resource.

`type`

Specifies the context in which to create the role. Valid options: 'SERVER' and 'DATABASE'.

Default: 'SERVER'.

`sqlserver::role::permissions`

Configures the permissions associated with a given role.

Requires the sqlserver::config defined type for access to the parent instance.

`database`

Specifies the database in which the role exists. Only valid if type is set to 'DATABASE'. Valid options: a string containing the name of an existing database.

Default: 'master'.

`instance`

Specifies a SQL Server instance on which to manage the role. Valid options: a string containing the name of an existing instance.

Default: 'MSSQLSERVER'.

`permissions`

Required.

Specifies one or more permissions to manage. Valid options: an array containing one or more SQL Server permissions (for example, 'SELECT', 'INSERT', 'UPDATE', and 'DELETE').

`role`

Required.

Specifies which role's permissions to manage. Valid options: a string containing the name of an existing role.

`state`

Determines the state of the specified permission. Valid options: 'GRANT', 'DENY', and 'REVOKE'. If set to 'REVOKE', Puppet removes any explicit statements of these permissions and falls back on inherited levels.

Default: 'GRANT'.

`type`

Specifies the permission context in which to create the role. Valid options: 'SERVER' and 'DATABASE'.

Default: 'SERVER'.

`with_grant_option`

Determines whether role members can grant these permissions to others. Valid options: true and false (true valid only if state is set to 'GRANT').

Default: false.

`sqlserver::sp_configure`

Updates and reconfigures SQL Server options using the sp_configure function. Required for partial containment or filestream functionality.

Requires the sqlserver::config defined type for access to the parent instance.

`config_name`

Specifies an option to manage in sys.configurations. Valid options: a string containing the config name.

Default: the title of your declared resource.

`instance`

Specifies a SQL Server instance on which to manage the option. Valid options: a string containing the name of an existing instance.

Default: 'MSSQLSERVER'.

`reconfigure`

Specifies whether to run RECONFIGURE after updating the option. Valid options: true and false.

Default: true.

`restart`

Specifies whether to notify the SQL Server service to restart after updating the option. Valid options: true and false.

Default: false.

`value`

Required.

Supplies a value for the specified option. Valid options: an integer.

`with_override`

Disables configuration value checking when updating the option. Valid only if reconfigure is set to true. Valid options: true and false.

Default: false.

For more information about these settings in SQL Server, please see:

Reconfigure

Server Configuration Options

Microsoft SQL Server terms

Terminology differs somewhat between various database systems; please refer to this list of terms for clarification.

Database: a collection of information organized into related tables of data and definitions of data objects.
Instance: an installed and running database service.
Login: a server-level account with permissions to one or more databases.
Role: a database-level or server-level permissions group.
User: a database-level account, typically mapped to a login.

Limitations

SQL 2017 detection support has been added. This support is limited to functionality already present for other versions. No new SQL 2017 specific functionality has been added in this release.

This module can manage only a single version of SQL Server on a given host (one and only one of SQL Server 2012, 2014 or 2016). The module is able to manage multiple SQL Server instances of the same version.

This module cannot manage the SQL Server Native Client SDK (also known as SNAC_SDK). The SQL Server installation media can install the SDK, but it is not able to uninstall the SDK. Note that the 'sqlserver_features' fact detects the presence of the SDK.

Development

This module was built by Puppet specifically for use with Puppet Enterprise (PE).

If you run into an issue with this module, or if you would like to request a feature, please file a ticket.

If you have problems getting this module up and running, please contact Support.

Name		Name	Last commit message	Last commit date
Latest commit History 645 Commits
examples		examples
lib		lib
locales		locales
manifests		manifests
readmes		readmes
spec		spec
templates		templates
.fixtures.yml		.fixtures.yml
.geppetto-rc.json		.geppetto-rc.json
.gitattributes		.gitattributes
.gitignore		.gitignore
.pdkignore		.pdkignore
.project		.project
.rspec		.rspec
.rubocop.yml		.rubocop.yml
.rubocop_todo.yml		.rubocop_todo.yml
.sync.yml		.sync.yml
.travis.yml		.travis.yml
.yardopts		.yardopts
CHANGELOG.md		CHANGELOG.md
CONTRIBUTING.md		CONTRIBUTING.md
Gemfile		Gemfile
LICENSE		LICENSE
MAINTAINERS.md		MAINTAINERS.md
README.md		README.md
Rakefile		Rakefile
appveyor.yml		appveyor.yml
metadata.json		metadata.json

License

Iristyle/puppetlabs-sqlserver

Folders and files

Latest commit

History

Repository files navigation

sqlserver

Table of contents

Overview

Module Description

Setup

Setup Requirements

Beginning with sqlserver

Usage

Install SQL Server tools and features not specific to a SQL Server instance

Create a new database on an instance of SQL Server

Set up a new login

Create a new login and a user for a given database

Manage the above user's permissions

Run custom TSQL statements

Use sqlserver_tsql to trigger other classes or defined types

Clean up regular logs with conditional checks

If you want your statement to always execute, leave out the onlyif parameter

Advanced example

Reference

Types

sqlserver_features

ensure

features

install_switches

is_svc_account

is_svc_password

pid

source

windows_feature_source

sqlserver_instance

agt_svc_account

agt_svc_password

as_svc_account

as_svc_password

as_sysadmin_accounts

ensure

features

install_switches

name

pid

polybase_svc_account

polybase_svc_password

rs_svc_account

rs_svc_password

sa_pwd

security_mode

source

sql_svc_account

sql_svc_password

sql_sysadmin_accounts

windows_feature_source

sqlserver_tsql

command

instance

database

onlyif

Defined Types

sqlserver::config

admin_login_type

instance_name

sqlserver::database

collation_name

compatibility:

containment

db_chaining

db_name: Required.

default_fulltext_language

default_language

ensure

filespec_filegrowth

filespec_filename

filespec_maxsize

filespec_name

filespec_size

Use `sqlserver_tsql` to trigger other classes or defined types

If you want your statement to always execute, leave out the `onlyif` parameter

`sqlserver_features`

`ensure`

`features`

`install_switches`

`is_svc_account`

`is_svc_password`

`pid`

`source`

`windows_feature_source`

`sqlserver_instance`

`agt_svc_account`

`agt_svc_password`

`as_svc_account`

`as_svc_password`

`as_sysadmin_accounts`

`ensure`

`features`

`install_switches`

`name`

`pid`

`polybase_svc_account`

`polybase_svc_password`

`rs_svc_account`

`rs_svc_password`

`sa_pwd`

`security_mode`

`source`

`sql_svc_account`

`sql_svc_password`

`sql_sysadmin_accounts`

`windows_feature_source`

`sqlserver_tsql`

`command`

`instance`

`database`

`onlyif`

`sqlserver::config`

`admin_login_type`

`instance_name`

`sqlserver::database`

`collation_name`

`compatibility`:

`containment`

`db_chaining`

`db_name`: Required.

`default_fulltext_language`

`default_language`

`ensure`

`filespec_filegrowth`

`filespec_filename`

`filespec_maxsize`

`filespec_name`

`filespec_size`

`filestream_directory_name`

`filestream_non_transacted_access`

`instance`

`log_filegrowth`

`log_filename`

`log_maxsize`

`log_name`

`log_size`

`nested_triggers`

`transform_noise_words`

`trustworthy`

`two_digit_year_cutoff`

`sqlserver::login`

`check_expiration`:

`check_policy`

`default_database`

`default_language`

`disabled`

`ensure`

`instance`

`login`

`login_type`

`password`

`svrroles`

`sqlserver::login::permissions`