You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: assets/dbatools-index.json
+20-11Lines changed: 20 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -20837,12 +20837,12 @@
20837
20837
],
20838
20838
[
20839
20839
"Type",
20840
-
"Returns firewall rules for the given type(s).\r\nValid values are:\r\n Engine - for the SQL Server instance\r\n Browser - for the SQL Server Browser\r\n AllInstance - for all firewall rules on the target computer related to SQL Server\r\nIf this parameter is not used, the firewall rule for the SQL Server instance will be returned\r\nand in case the instance is listening on a port other than 1433,\r\nalso the firewall rule for the SQL Server Browser will be returned.",
20840
+
"Returns firewall rules for the given type(s).\r\nValid values are:\r\n Engine - for the SQL Server instance\r\n Browser - for the SQL Server Browser\r\n DAC - for the dedicated admin connection (DAC)\r\n AllInstance - for all firewall rules on the target computer related to SQL Server\r\nIf this parameter is not used, the firewall rule for the SQL Server instance will be returned\r\nand in case the instance is listening on a port other than 1433,\r\nalso the firewall rule for the SQL Server Browser will be returned.",
20841
20841
"",
20842
20842
false,
20843
20843
"false",
20844
20844
"",
20845
-
"Engine,Browser,AllInstance"
20845
+
"Engine,Browser,DAC,AllInstance"
20846
20846
],
20847
20847
[
20848
20848
"EnableException",
@@ -29138,7 +29138,7 @@
29138
29138
},
29139
29139
{
29140
29140
"Name": "Install-DbaInstance",
29141
-
"Description": "This function will help you to quickly install a SQL Server instance on one or many computers.\nSome of the things this function will do for you:\n* Add your login as an admin to the new instance\n* Search for SQL Server installations in the specified file repository\n* Generate SA password if needed\n* Install specific features using \u0027Default\u0027 and \u0027All\u0027 templates or cherry-pick the ones you need\n* Set number of tempdb files based on number of cores (SQL2016+)\n* Activate .Net 3.5 feature for SQL2012/2014\n* Restart the machine if needed after the installation is done\n\nFully customizable installation parameters allow you to:\n* Use existing Configuration.ini files for the installation\n* Define service account credentials using native Powershell syntax\n* Override any configurations by using -Configuration switch\n* Change the TCP port after the installation is done\n* Enable \u0027Perform volume maintenance tasks\u0027 for the SQL Server account\n\nNote that the dowloaded installation media must be extracted and available to the server where the installation runs.\nNOTE: If no ProductID (PID) is found in the configuration files/parameters, Evaluation version is going to be installed.\n\nWhen using CredSSP authentication, this function will try to configure CredSSP authentication for PowerShell Remoting sessions.\nIf this is not desired (e.g.: CredSSP authentication is managed externally, or is already configured appropriately,)\nit can be disabled by setting the dbatools configuration option \u0027commands.initialize-credssp.bypass\u0027 value to $true.\nTo be able to configure CredSSP, the command needs to be run in an elevated PowerShell session.",
29141
+
"Description": "This function will help you to quickly install a SQL Server instance on one or many computers.\nSome of the things this function will do for you:\n* Add your login as an admin to the new instance\n* Search for SQL Server installations in the specified file repository\n* Generate SA password if needed\n* Install specific features using \u0027Default\u0027 and \u0027All\u0027 templates or cherry-pick the ones you need\n* Set number of tempdb files based on number of cores (SQL2016+)\n* Activate .Net 3.5 feature for SQL2012/2014\n* Restart the machine if needed after the installation is done\n\nFully customizable installation parameters allow you to:\n* Use existing Configuration.ini files for the installation\n* Define service account credentials using native Powershell syntax\n* Override any configurations by using -Configuration switch\n* Change the TCP port after the installation is done\n* Enable \u0027Perform volume maintenance tasks\u0027 for the SQL Server account\n\nNote that the downloaded installation media must be extracted and available to the server where the installation runs.\nNOTE: If no ProductID (PID) is found in the configuration files/parameters, Evaluation version is going to be installed.\n\nWhen using CredSSP authentication, this function will try to configure CredSSP authentication for PowerShell Remoting sessions.\nIf this is not desired (e.g.: CredSSP authentication is managed externally, or is already configured appropriately,)\nit can be disabled by setting the dbatools configuration option \u0027commands.initialize-credssp.bypass\u0027 value to $true.\nTo be able to configure CredSSP, the command needs to be run in an elevated PowerShell session.",
29142
29142
"Tags": [
29143
29143
"Deployment",
29144
29144
"Install"
@@ -41408,7 +41408,7 @@
41408
41408
},
41409
41409
{
41410
41410
"Name": "New-DbaFirewallRule",
41411
-
"Description": "Creates a new inbound firewall rule for a SQL Server instance and adds the rule to the target computer.\n\nThis is basically a wrapper around New-NetFirewallRule executed at the target computer.\nSo this only works if New-NetFirewallRule works on the target computer.\n\nBoth DisplayName and Name are set to the same value, since DisplayName is required\nbut only Name uniquely defines the rule, thus avoiding duplicate rules with different settings.\nThe names and the group for all rules are fixed to be able to get them back with Get-DbaFirewallRule.\n\nThe functionality is currently limited. Help to extend the functionality is welcome.\n\nAs long as you can read this note here, there may be breaking changes in future versions.\nSo please review your scripts using this command after updating dbatools.\n\nThe firewall rule for the instance itself will have the following configuration (parameters for New-NetFirewallRule):\n DisplayName = \u0027SQL Server default instance\u0027 or \u0027SQL Server instance \u003cInstanceName\u003e\u0027\n Name = \u0027SQL Server default instance\u0027 or \u0027SQL Server instance \u003cInstanceName\u003e\u0027\n Group = \u0027SQL Server\u0027\n Enabled = \u0027True\u0027\n Direction = \u0027Inbound\u0027\n Protocol = \u0027TCP\u0027\n LocalPort = \u0027\u003cPort\u003e\u0027 (for instances with static port)\n Program = \u0027\u003cPath ending with MSSQL\\Binn\\sqlservr.exe\u003e\u0027 (for instances with dynamic port)\n\nThe firewall rule for the SQL Server Browser will have the following configuration (parameters for New-NetFirewallRule):\n DisplayName = \u0027SQL Server Browser\u0027\n Name = \u0027SQL Server Browser\u0027\n Group = \u0027SQL Server\u0027\n Enabled = \u0027True\u0027\n Direction = \u0027Inbound\u0027\n Protocol = \u0027UDP\u0027\n LocalPort = \u00271434\u0027",
41411
+
"Description": "Creates a new inbound firewall rule for a SQL Server instance and adds the rule to the target computer.\n\nThis is basically a wrapper around New-NetFirewallRule executed at the target computer.\nSo this only works if New-NetFirewallRule works on the target computer.\n\nBoth DisplayName and Name are set to the same value, since DisplayName is required\nbut only Name uniquely defines the rule, thus avoiding duplicate rules with different settings.\nThe names and the group for all rules are fixed to be able to get them back with Get-DbaFirewallRule.\n\nThe functionality is currently limited. Help to extend the functionality is welcome.\n\nAs long as you can read this note here, there may be breaking changes in future versions.\nSo please review your scripts using this command after updating dbatools.\n\nThe firewall rule for the instance itself will have the following configuration (parameters for New-NetFirewallRule):\n DisplayName = \u0027SQL Server default instance\u0027 or \u0027SQL Server instance \u003cInstanceName\u003e\u0027\n Name = \u0027SQL Server default instance\u0027 or \u0027SQL Server instance \u003cInstanceName\u003e\u0027\n Group = \u0027SQL Server\u0027\n Enabled = \u0027True\u0027\n Direction = \u0027Inbound\u0027\n Protocol = \u0027TCP\u0027\n LocalPort = \u0027\u003cPort\u003e\u0027 (for instances with static port)\n Program = \u0027\u003cPath ending with MSSQL\\Binn\\sqlservr.exe\u003e\u0027 (for instances with dynamic port)\n\nThe firewall rule for the SQL Server Browser will have the following configuration (parameters for New-NetFirewallRule):\n DisplayName = \u0027SQL Server Browser\u0027\n Name = \u0027SQL Server Browser\u0027\n Group = \u0027SQL Server\u0027\n Enabled = \u0027True\u0027\n Direction = \u0027Inbound\u0027\n Protocol = \u0027UDP\u0027\n LocalPort = \u00271434\u0027\n\nThe firewall rule for the dedicated admin connection (DAC) will have the following configuration (parameters for New-NetFirewallRule):\n DisplayName = \u0027SQL Server default instance (DAC)\u0027 or \u0027SQL Server instance \u003cInstanceName\u003e (DAC)\u0027\n Name = \u0027SQL Server default instance (DAC)\u0027 or \u0027SQL Server instance \u003cInstanceName\u003e (DAC)\u0027\n Group = \u0027SQL Server\u0027\n Enabled = \u0027True\u0027\n Direction = \u0027Inbound\u0027\n Protocol = \u0027TCP\u0027\n LocalPort = \u0027\u003cPort\u003e\u0027 (typically 1434 for a default instance, but will be fetched from ERRORLOG)\nThe firewall rule for the DAC will only be created if the DAC is configured for listening remotely.\nUse `Set-DbaSpConfigure -SqlInstance SRV1 -Name RemoteDacConnectionsEnabled -Value 1` to enable remote DAC before running this command.",
41412
41412
"Tags": [
41413
41413
"Network",
41414
41414
"Connection",
@@ -41442,12 +41442,12 @@
41442
41442
],
41443
41443
[
41444
41444
"Type",
41445
-
"Creates firewall rules for the given type(s).\r\nValid values are:\r\n Engine - for the SQL Server instance\r\n Browser - for the SQL Server Browser\r\nIf this parameter is not used, the firewall rule for the SQL Server instance will be created\r\nand in case the instance is listening on a port other than 1433,\r\nalso the firewall rule for the SQL Server Browser will be created if not already in place.",
41445
+
"Creates firewall rules for the given type(s).\r\nValid values are:\r\n Engine - for the SQL Server instance\r\n Browser - for the SQL Server Browser\r\n DAC - for the dedicated admin connection (DAC)\r\nIf this parameter is not used:\r\n The firewall rule for the SQL Server instance will be created.\r\n In case the instance is listening on a port other than 1433, also the firewall rule for the SQL Server Browser will be created if not already in place.\r\n In case the DAC is configured for listening remotely, also the firewall rule for the DAC will be created.",
41446
41446
"",
41447
41447
false,
41448
41448
"false",
41449
41449
"",
41450
-
"Engine,Browser"
41450
+
"Engine,Browser,DAC"
41451
41451
],
41452
41452
[
41453
41453
"Configuration",
@@ -48324,12 +48324,12 @@
48324
48324
],
48325
48325
[
48326
48326
"Type",
48327
-
"Removes firewall rules for the given type(s).\r\nValid values are:\r\n Engine - for the SQL Server instance\r\n Browser - for the SQL Server Browser\r\n AllInstance - for all firewall rules on the target computer related to SQL Server\r\nThe default is \u0027Engine\u0027.\r\nAs the Browser might be needed by other instances, the firewall rule for the SQL Server Browser is\r\nnever removed with the firewall rule of the instance but only removed if \u0027Browser\u0027 is used.",
48327
+
"Removes firewall rules for the given type(s).\r\nValid values are:\r\n Engine - for the SQL Server instance\r\n Browser - for the SQL Server Browser\r\n DAC - for the dedicated admin connection (DAC)\r\n AllInstance - for all firewall rules on the target computer related to SQL Server\r\nThe default is @(\u0027Engine\u0027, \u0027DAC\u0027).\r\nAs the Browser might be needed by other instances, the firewall rule for the SQL Server Browser is\r\nnever removed with the firewall rule of the instance but only removed if \u0027Browser\u0027 is used.",
48328
48328
"",
48329
48329
false,
48330
48330
"false",
48331
-
"Engine",
48332
-
"Engine,Browser,AllInstance"
48331
+
"@(\u0027Engine\u0027, \u0027DAC\u0027)",
48332
+
"Engine,Browser,DAC,AllInstance"
48333
48333
],
48334
48334
[
48335
48335
"InputObject",
@@ -51227,13 +51227,22 @@
51227
51227
"master",
51228
51228
""
51229
51229
],
51230
+
[
51231
+
"Name",
51232
+
"The optional name for the certificate, otherwise, it will be guessed from the certificate file name.",
0 commit comments