Skip to content

Commit e64f1cf

Browse files
author
Travis Fields
committed
Add readme updates to reflect changes
1 parent 2b3c184 commit e64f1cf

File tree

1 file changed

+43
-32
lines changed

1 file changed

+43
-32
lines changed

README.md

Lines changed: 43 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,19 @@
1515

1616
##Overview
1717

18-
The sqlserver module installs and manages Microsoft SQL Server 2012 and 2014 on Windows systems.
18+
The sqlserver module installs and manages Microsoft SQL Server 2012 and 2014 on Windows systems.
1919

2020
##Module Description
21-
22-
The sqlserver module adds defined types to install and manage Microsoft SQL Server 2012 and 2014 on Windows Server 2012. The module can install SQL Server clients, multiple instances, and SQL features, as well as create and manage new databases and logins.
21+
22+
The sqlserver module adds defined types to install and manage Microsoft SQL Server 2012 and 2014 on Windows Server 2012. The module can install SQL Server clients, multiple instances, and SQL features, as well as create and manage new databases and logins.
2323

2424
##Setup
2525

2626
###What sqlserver affects
2727

2828
This module requires .NET 3.5 and installs it if it's not already on your system. This might require an internet connection.
2929

30-
###Setup Requirements
30+
###Setup Requirements
3131

3232
The sqlserver module requires the following:
3333

@@ -36,10 +36,10 @@ The sqlserver module requires the following:
3636
* .NET 3.5
3737
* ISO, mounted or expanded either locally or on a network share
3838
* Windows Server 2012 or 2012R2
39-
39+
4040
###Beginning with sqlserver
4141

42-
To get started with the sqlserver module, include these settings in your manifest:
42+
To get started with the sqlserver module, include these settings in your manifest:
4343

4444
```
4545
sqlserver_instance{'MSSQLSERVER':
@@ -79,7 +79,7 @@ sqlserver::database{ 'minviable':
7979
}
8080
```
8181

82-
###To set up a new login:
82+
###To set up a new login:
8383

8484
```
8585
SQL Login
@@ -88,7 +88,7 @@ sqlserver::login{'vagrant':
8888
password => 'Pupp3t1@',
8989
}
9090
91-
Windows Login
91+
Windows Login
9292
sqlserver::login{'WIN-D95P1A3V103\localAccount':
9393
instance => 'MSSQLSERVER',
9494
login_type => 'WINDOWS_LOGIN',
@@ -114,10 +114,15 @@ Terminology differs somewhat between various database systems; please refer to t
114114
* `ensure`: Ensures that the resource is present. Valid values are 'present', 'absent'.
115115
* `features`: Specifies features to install or uninstall. The list of top-level features include IS, MDS, and Tools. The Tools feature will install Management Tools, SQL Server Data Tools, and other shared components. Valid values are 'Tools', 'BC', 'Conn', 'SSMS', 'ADV_SSMS', 'SDK', 'IS', 'MDS'.
116116
* `is_svc_account`: Either domain user name or system account. Defaults to 'NT AUTHORITY\NETWORK SERVICE'.
117-
* `is_svc_password`: Password for domain user.
117+
* `is_svc_password`: Password for domain user.
118118
* `pid`: Specify the SQL Server product key to configure which edition you would like to use. Can be left empty for evaluation versions.
119-
* `provider`: The specific backend to use for this `sqlserver_features` resource. You seldom need to specify this---Puppet will usually discover the appropriate provider for your platform. Available providers are: `mssql`, `source`.
120-
119+
* `install_switches`: Hash of install switches you would like to be based to a config file during installation.
120+
121+
** Please not that any duplicates from what we provide on the command line will be ignored. For more information see the links below
122+
123+
* [Installer switches](https://msdn.microsoft.com/en-us/library/ms144259.aspx)
124+
* [Configuration File](https://msdn.microsoft.com/en-us/library/dd239405.aspx)
125+
121126
#### sqlserver_instance
122127

123128
* `agt_svc_account`: Either domain user name or system account.
@@ -138,23 +143,29 @@ Terminology differs somewhat between various database systems; please refer to t
138143
* `sql_svc_account`: Account for SQL Server service: Domain\User or system account.
139144
* `sql_svc_password`: The SQL Server service password; required only for a domain account.
140145
* `sql_sysadmin_accounts`: The Windows or SQL account(s) to provision as SQL Server system administrators.
146+
* `install_switches`: Hash of install switches you would like to be based to a config file during installation.
147+
148+
** Please not that any duplicates from what we provide on the command line will be ignored. For more information see the links below
149+
150+
* [Installer switches](https://msdn.microsoft.com/en-us/library/ms144259.aspx)
151+
* [Configuration File](https://msdn.microsoft.com/en-us/library/dd239405.aspx)
141152

142153
### Defined Types
143154

144155
#### `sqlserver::config`
145156

146-
Stores the config file that allows Puppet to access and modify the instance.
157+
Stores the config file that allows Puppet to access and modify the instance.
147158

148159
* `instance_name`: The instance name you want to manage. Defaults to the name of the define.
149-
* `admin_user`: The SQL login with sysadmin rights on the server, can only be login of SQL_Login type.
160+
* `admin_user`: The SQL login with sysadmin rights on the server, can only be login of SQL_Login type.
150161
* `admin_pass`: The password to access the server to be managed.
151162

152163
```
153164
sqlserver::config{'MSSQLSERVER':
154165
admin_user => 'sa',
155166
admin_pass => 'PuppetP@ssword1',
156167
}
157-
```
168+
```
158169

159170
#### `sqlserver::database`
160171

@@ -165,23 +176,23 @@ Creates, destroys, or updates databases, but does not move or modify files. Requ
165176
* `ensure`: Ensures that the resource is present. Valid values are 'present', 'absent'. Defaults to 'present'.
166177
* `compatibility`: Numeric representation of the SQL Server version with which the database should be compatible. For example, 100 = SQL Server 2008 through SQL Server 2012. For a complete list of values, refer to [http://msdn.microsoft.com/en-us/library/bb510680.aspx](http://msdn.microsoft.com/en-us/library/bb510680.aspx).
167178
* `collation_name`: Modifies dictionary default sort rules for the datatbase. Defaults to 'Latin1_General'. To find out what other values your system supports, run the query `SELECT * FROM sys.fn_helpcollations() WHERE name LIKE 'SQL%'`.
168-
* `filestream_non_transacted_access`: Specifies the level of non-transactional FILESTREAM access to the database. This parameter is affected only at creation; updates will not change this setting. Valid values are 'OFF', 'READ_ONLY', 'FULL'. Requires defined type `sqlserver::sp_configure`.
169-
* `filestream_directory_name`: Accepts a Windows-compatible directory name. This name should be unique among all the Database_Directory names in the SQL Server instance. Uniqueness comparison is case-insensitive, regardless of SQL Server collation settings. This option should be set before creating a FileTable in this database. This parameter is affected only at creation; updates will not change this setting. Requires defined type `sqlserver::sp_configure`.
170-
* `filespec_name`: Specifies the logical name for the file. NAME is required when FILENAME is specified, except when specifying one of the FOR ATTACH clauses. A FILESTREAM filegroup cannot be named PRIMARY. This parameter is affected only at creation; updates will not change this setting.
171-
* `filespec_filename`: Specifies the operating system (physical) file name. This parameter is affected only at creation; updates will not change this setting.
172-
* `filespec_size`: Specifies the size of the file. The kilobyte (KB), megabyte (MB), gigabyte (GB), or terabyte (TB) suffixes can be used. The default is MB. Values can not be greater than 2147483647. This parameter is affected only at creation; updates will not change this setting.
173-
* `filespec maxsize`: Specifies the maximum size to which the file can grow. MAXSIZE cannot be specified when the os_file_name is specified as a UNC path. This parameter is affected only at creation; updates will not change this setting.
174-
* `filespec_filegrowth`: Specifies the automatic growth increment of the file. The FILEGROWTH setting for a file cannot exceed the MAXSIZE setting. FILEGROWTH cannot be specified when the os_file_name is specified as a UNC path. FILEGROWTH does not apply to a FILESTREAM filegroup. This parameter is affected only at creation; updates will not change this setting.
175-
* `log_name`: Specifies the logical name for the file. NAME is required when FILENAME is specified, except when specifying one of the FOR ATTACH clauses. A FILESTREAM filegroup cannot be named PRIMARY. This parameter is affected only at creation; updates will not change this setting.
176-
* `log_filename`: Specifies the operating system (physical) file name. This parameter is affected only at creation; updates will not change this setting.
177-
* `log_size`: Specifies the size of the file. The kilobyte (KB), megabyte (MB), gigabyte (GB), or terabyte (TB) suffixes can be used. The default is MB. Values can not be greater than 2147483647. This parameter is affected only at creation; updates will not change this setting.
178-
* `log_maxsize`: Specifies the maximum size to which the file can grow. MAXSIZE cannot be specified when the os_file_name is specified as a UNC path. This parameter is affected only at creation; updates will not change this setting.
179-
* `log_filegrowth`: Specifies the automatic growth increment of the file. The FILEGROWTH setting for a file cannot exceed the MAXSIZE setting. FILEGROWTH cannot be specified when the os_file_name is specified as a UNC path. FILEGROWTH does not apply to a FILESTREAM filegroup. This parameter is affected only at creation; updates will not change this setting.
179+
* `filestream_non_transacted_access`: Specifies the level of non-transactional FILESTREAM access to the database. This parameter is affected only at creation; updates will not change this setting. Valid values are 'OFF', 'READ_ONLY', 'FULL'. Requires defined type `sqlserver::sp_configure`.
180+
* `filestream_directory_name`: Accepts a Windows-compatible directory name. This name should be unique among all the Database_Directory names in the SQL Server instance. Uniqueness comparison is case-insensitive, regardless of SQL Server collation settings. This option should be set before creating a FileTable in this database. This parameter is affected only at creation; updates will not change this setting. Requires defined type `sqlserver::sp_configure`.
181+
* `filespec_name`: Specifies the logical name for the file. NAME is required when FILENAME is specified, except when specifying one of the FOR ATTACH clauses. A FILESTREAM filegroup cannot be named PRIMARY. This parameter is affected only at creation; updates will not change this setting.
182+
* `filespec_filename`: Specifies the operating system (physical) file name. This parameter is affected only at creation; updates will not change this setting.
183+
* `filespec_size`: Specifies the size of the file. The kilobyte (KB), megabyte (MB), gigabyte (GB), or terabyte (TB) suffixes can be used. The default is MB. Values can not be greater than 2147483647. This parameter is affected only at creation; updates will not change this setting.
184+
* `filespec maxsize`: Specifies the maximum size to which the file can grow. MAXSIZE cannot be specified when the os_file_name is specified as a UNC path. This parameter is affected only at creation; updates will not change this setting.
185+
* `filespec_filegrowth`: Specifies the automatic growth increment of the file. The FILEGROWTH setting for a file cannot exceed the MAXSIZE setting. FILEGROWTH cannot be specified when the os_file_name is specified as a UNC path. FILEGROWTH does not apply to a FILESTREAM filegroup. This parameter is affected only at creation; updates will not change this setting.
186+
* `log_name`: Specifies the logical name for the file. NAME is required when FILENAME is specified, except when specifying one of the FOR ATTACH clauses. A FILESTREAM filegroup cannot be named PRIMARY. This parameter is affected only at creation; updates will not change this setting.
187+
* `log_filename`: Specifies the operating system (physical) file name. This parameter is affected only at creation; updates will not change this setting.
188+
* `log_size`: Specifies the size of the file. The kilobyte (KB), megabyte (MB), gigabyte (GB), or terabyte (TB) suffixes can be used. The default is MB. Values can not be greater than 2147483647. This parameter is affected only at creation; updates will not change this setting.
189+
* `log_maxsize`: Specifies the maximum size to which the file can grow. MAXSIZE cannot be specified when the os_file_name is specified as a UNC path. This parameter is affected only at creation; updates will not change this setting.
190+
* `log_filegrowth`: Specifies the automatic growth increment of the file. The FILEGROWTH setting for a file cannot exceed the MAXSIZE setting. FILEGROWTH cannot be specified when the os_file_name is specified as a UNC path. FILEGROWTH does not apply to a FILESTREAM filegroup. This parameter is affected only at creation; updates will not change this setting.
180191
* `containment`: Defaults to 'NONE'.Other possible values are 'PARTIAL'. Setting `containment` =>'PARTIAL' requires defined type `sqlserver::sp_configure`. See [http://msdn.microsoft.com/en-us/library/ff929071.aspx](http://msdn.microsoft.com/en-us/library/ff929071.aspx) for complete documentation about containment.
181192
* `default_fulltext_language`: Sets default fulltext language. Only applicable if `containment` => ‘PARTIAL’. Valid values are documented at [http://msdn.microsoft.com/en-us/library/ms190303.aspx](http://msdn.microsoft.com/en-us/library/ms190303.aspx). Defaults to 'us_english'.
182193
* `default_language`: Sets default language. Only applicable if `containment` => ‘PARTIAL’. Valid values are documented at http://msdn.microsoft.com/en-us/library/ms190303.aspx. Defaults to 'us_english'.
183194
* `nested_triggers`: Enables cascading triggers. Only applicable if `containment` => ‘PARTIAL’. Valid values are 'ON', 'OFF'. See [http://msdn.microsoft.com/en-us/library/ms178101.aspx](http://msdn.microsoft.com/en-us/library/ms178101.aspx) for complete documentation.
184-
* `transform_noise_words`: Removes noise or stop words, such as “is”, “the”, “this”. Only applicable if `containment` => ‘PARTIAL’. Valid values are 'ON', 'OFF'.
195+
* `transform_noise_words`: Removes noise or stop words, such as “is”, “the”, “this”. Only applicable if `containment` => ‘PARTIAL’. Valid values are 'ON', 'OFF'.
185196
* `two_digit_year_cutoff`: The year at which the system will treat the year as four digits instead of two. For example, if set to '1999', 1998 would be abbreviated to '98', while 2014 would be '2014'. Only applicable if `containment` => ‘PARTIAL’. Valid values are any year between 1753 and 9999. Defaults to 2049.
186197
* `db_chaining`: Whether the database can be the source or target of a cross-database ownership chain. Only applicable if `containment` => ‘PARTIAL’. Valid values are 'ON', 'OFF'. Defaults to 'OFF'.
187198
* `trustworthy`: 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` => ‘PARTIAL’. Valid values are 'ON', 'OFF'. Defaults to 'OFF'.
@@ -208,13 +219,13 @@ Requires defined type `sqlserver::config`.
208219
* `default_database`: Sets the database the login should default to when connecting. Defaults to 'master'.
209220
* `default_language`: Sets default language. Valid values are documented at http://msdn.microsoft.com/en-us/library/ms190303.aspx. Defaults to 'us_english'.
210221
* `check_expiration`: For SQL logins, checks to see if password has expired and user should be forced to change the password. Only applicable when Login_Type = 'SQL_LOGIN'. Valid values are 'true', 'false'. Default value is 'false'.
211-
* `check_policy`: Checks the password policy. Only applicable when Login_Type = 'SQL_LOGIN'. Valid values are 'true', 'false'. Defaults to 'true'.
212-
* `disabled`: Valid values are 'true', 'false'. Defaults to 'false'.
222+
* `check_policy`: Checks the password policy. Only applicable when Login_Type = 'SQL_LOGIN'. Valid values are 'true', 'false'. Defaults to 'true'.
223+
* `disabled`: Valid values are 'true', 'false'. Defaults to 'false'.
213224

214225
**For more information about these settings and configuration in Microsoft SQL Server, please see:**
215226

216227
* [Server Role Members](http://msdn.microsoft.com/en-us/library/ms186320.aspx)
217-
* [Create Login](http://technet.microsoft.com/en-us/library/ms189751.aspx)
228+
* [Create Login](http://technet.microsoft.com/en-us/library/ms189751.aspx)
218229
* [Alter Login](http://technet.microsoft.com/en-us/library/ms189828.aspx)
219230

220231
#### sqlserver::sp_configure
@@ -230,12 +241,12 @@ This defined type configures the instance to allow usage of filestream parameter
230241

231242
**For more information about these settings and configuration in Microsoft SQL Server, please see:**
232243

233-
* [Reconfigure](http://msdn.microsoft.com/en-us/library/ms176069.aspx)
244+
* [Reconfigure](http://msdn.microsoft.com/en-us/library/ms176069.aspx)
234245
* [Server Configuration Options](http://msdn.microsoft.com/en-us/library/ms189631.aspx)
235246

236247
##Limitations
237248

238-
This module is available only for Puppet Enterprise 3.7 and later.
249+
This module is available only for Puppet Enterprise 3.7 and later.
239250

240251
##Development
241252

0 commit comments

Comments
 (0)