Skip to content

Commit 9079383

Browse files
potatoqualiteegithub-actions[bot]
authored andcommitted
refreshing docs pages
1 parent 9a125a2 commit 9079383

File tree

701 files changed

+13715
-4204
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

701 files changed

+13715
-4204
lines changed

Add-DbaAgDatabase.html

Lines changed: 42 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@
2020
<meta property="og:site_name" content="docs.dbatools.io" />
2121
<meta property="og:locale" content="en_US" />
2222
<meta name="twitter:text:title" content="dbatools docs: Add-DbaAgDatabase" />
23-
23+
2424
<meta name="twitter:image" content="https://docs.dbatools.io/assets/thumbs/Add-DbaAgDatabase.png">
2525
<meta name="twitter:card" content="summary_large_image">
26-
26+
2727
<meta name=twitter:creator content="@psdbatools">
2828
<meta name=twitter:title content="dbatools docs: Add-DbaAgDatabase">
2929
<meta property="twitter:site" content="@psdbatools" />
@@ -145,7 +145,7 @@
145145
}
146146
$(document).ready(function () {
147147
function render_doc(doc_to_render, examples_mode) {
148-
148+
149149
$("#rendered h5").each(function (i, el) {
150150
if ($(el).text().startsWith('-')) {
151151
$(el).addClass('param')
@@ -180,7 +180,7 @@
180180
}
181181

182182

183-
//not all code is a block
183+
//not all code is a block
184184
$("#rendered h3[id*='-parameters']").nextAll().find('code').addClass('hljs-inline')
185185
$('#rendered #description').nextUntil('#rendered #syntax').find('code').addClass('hljs-inline')
186186
}
@@ -393,7 +393,7 @@
393393

394394
<nav class="navbar navbar-expand-md customnav">
395395
<a href="https://docs.dbatools.io/" class="navbar-brand" rel="home" itemprop="url">
396-
<img width="265" height="64" src="https://dbatools.io/images/dbatools-docs.png"
396+
<img width="265" height="64" src="https://dbatools.io/wp-content/uploads/2018/09/dbatools-docs.png"
397397
class="custom-logo" alt="dbatools" itemprop="logo" scale="0">
398398
</a>
399399
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarCollapse"
@@ -530,6 +530,7 @@ <h2 id="syntax">Syntax</h2>
530530
[-SharedPath &lt;String&gt;]
531531
[-UseLastBackup]
532532
[-AdvancedBackupParams &lt;Hashtable&gt;]
533+
[-NoWait]
533534
[-EnableException]
534535
[-WhatIf]
535536
[-Confirm]
@@ -544,6 +545,7 @@ <h2 id="syntax">Syntax</h2>
544545
[-SharedPath &lt;String&gt;]
545546
[-UseLastBackup]
546547
[-AdvancedBackupParams &lt;Hashtable&gt;]
548+
[-NoWait]
547549
[-EnableException]
548550
[-WhatIf]
549551
[-Confirm]
@@ -585,6 +587,10 @@ <h5 id="example-5">Example: 5</h5>
585587
PS C:\&gt; Add-DbaAgDatabase @splat -AdvancedBackupParams $adv_param
586588
</code></pre>
587589
<p>Adds db1 to ag1 on sql2017a and sql2017b. Uses compression and three files while taking the backups.<br></p>
590+
<h5 id="example-6">Example: 6</h5>
591+
<pre><code>PS C:\&gt; Add-DbaAgDatabase -SqlInstance sql2017a -AvailabilityGroup ag1 -Database db1 -NoWait
592+
</code></pre>
593+
<p>Adds db1 to ag1 on sql2017a and returns immediately without waiting for seeding to complete on secondary replicas. Seeding will continue in the background.<br></p>
588594
<h3 id="required-parameters">Required Parameters</h3>
589595
<h5 id="sqlinstance">-SqlInstance</h5>
590596
<p>The primary replica of the Availability Group. Server version must be SQL Server version 2012 or higher. <br></p>
@@ -911,6 +917,37 @@ <h5 id="advancedbackupparams">-AdvancedBackupParams</h5>
911917
</tr>
912918
</tbody>
913919
</table>
920+
<h5 id="nowait">-NoWait</h5>
921+
<p>Skips waiting for the database seeding and synchronization to complete on secondary replicas (Step 5).<br />
922+
The underlying SQL command ALTER AVAILABILITY GROUP ... ADD DATABASE is immediate and does not wait for seeding to finish.<br />
923+
Use this when you want the command to return immediately after adding the database to the AG, allowing seeding to continue in the background.<br />
924+
This is particularly useful in deployments where seeding can take a long time and you want to start using the environment before synchronization completes.<br></p>
925+
<table>
926+
<thead>
927+
<tr>
928+
<th></th>
929+
<th></th>
930+
</tr>
931+
</thead>
932+
<tbody>
933+
<tr>
934+
<td>Alias</td>
935+
<td></td>
936+
</tr>
937+
<tr>
938+
<td>Required</td>
939+
<td>False</td>
940+
</tr>
941+
<tr>
942+
<td>Pipeline</td>
943+
<td>false</td>
944+
</tr>
945+
<tr>
946+
<td>Default Value</td>
947+
<td>False</td>
948+
</tr>
949+
</tbody>
950+
</table>
914951
<h5 id="enableexception">-EnableException</h5>
915952
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
916953
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />

Add-DbaAgListener.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@
2020
<meta property="og:site_name" content="docs.dbatools.io" />
2121
<meta property="og:locale" content="en_US" />
2222
<meta name="twitter:text:title" content="dbatools docs: Add-DbaAgListener" />
23-
23+
2424
<meta name="twitter:image" content="https://docs.dbatools.io/assets/thumbs/Add-DbaAgListener.png">
2525
<meta name="twitter:card" content="summary_large_image">
26-
26+
2727
<meta name=twitter:creator content="@psdbatools">
2828
<meta name=twitter:title content="dbatools docs: Add-DbaAgListener">
2929
<meta property="twitter:site" content="@psdbatools" />
@@ -145,7 +145,7 @@
145145
}
146146
$(document).ready(function () {
147147
function render_doc(doc_to_render, examples_mode) {
148-
148+
149149
$("#rendered h5").each(function (i, el) {
150150
if ($(el).text().startsWith('-')) {
151151
$(el).addClass('param')
@@ -180,7 +180,7 @@
180180
}
181181

182182

183-
//not all code is a block
183+
//not all code is a block
184184
$("#rendered h3[id*='-parameters']").nextAll().find('code').addClass('hljs-inline')
185185
$('#rendered #description').nextUntil('#rendered #syntax').find('code').addClass('hljs-inline')
186186
}
@@ -393,7 +393,7 @@
393393

394394
<nav class="navbar navbar-expand-md customnav">
395395
<a href="https://docs.dbatools.io/" class="navbar-brand" rel="home" itemprop="url">
396-
<img width="265" height="64" src="https://dbatools.io/images/dbatools-docs.png"
396+
<img width="265" height="64" src="https://dbatools.io/wp-content/uploads/2018/09/dbatools-docs.png"
397397
class="custom-logo" alt="dbatools" itemprop="logo" scale="0">
398398
</a>
399399
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarCollapse"

Add-DbaAgReplica.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@
2020
<meta property="og:site_name" content="docs.dbatools.io" />
2121
<meta property="og:locale" content="en_US" />
2222
<meta name="twitter:text:title" content="dbatools docs: Add-DbaAgReplica" />
23-
23+
2424
<meta name="twitter:image" content="https://docs.dbatools.io/assets/thumbs/Add-DbaAgReplica.png">
2525
<meta name="twitter:card" content="summary_large_image">
26-
26+
2727
<meta name=twitter:creator content="@psdbatools">
2828
<meta name=twitter:title content="dbatools docs: Add-DbaAgReplica">
2929
<meta property="twitter:site" content="@psdbatools" />
@@ -145,7 +145,7 @@
145145
}
146146
$(document).ready(function () {
147147
function render_doc(doc_to_render, examples_mode) {
148-
148+
149149
$("#rendered h5").each(function (i, el) {
150150
if ($(el).text().startsWith('-')) {
151151
$(el).addClass('param')
@@ -180,7 +180,7 @@
180180
}
181181

182182

183-
//not all code is a block
183+
//not all code is a block
184184
$("#rendered h3[id*='-parameters']").nextAll().find('code').addClass('hljs-inline')
185185
$('#rendered #description').nextUntil('#rendered #syntax').find('code').addClass('hljs-inline')
186186
}
@@ -393,7 +393,7 @@
393393

394394
<nav class="navbar navbar-expand-md customnav">
395395
<a href="https://docs.dbatools.io/" class="navbar-brand" rel="home" itemprop="url">
396-
<img width="265" height="64" src="https://dbatools.io/images/dbatools-docs.png"
396+
<img width="265" height="64" src="https://dbatools.io/wp-content/uploads/2018/09/dbatools-docs.png"
397397
class="custom-logo" alt="dbatools" itemprop="logo" scale="0">
398398
</a>
399399
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarCollapse"

Add-DbaComputerCertificate.html

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@
2020
<meta property="og:site_name" content="docs.dbatools.io" />
2121
<meta property="og:locale" content="en_US" />
2222
<meta name="twitter:text:title" content="dbatools docs: Add-DbaComputerCertificate" />
23-
23+
2424
<meta name="twitter:image" content="https://docs.dbatools.io/assets/thumbs/Add-DbaComputerCertificate.png">
2525
<meta name="twitter:card" content="summary_large_image">
26-
26+
2727
<meta name=twitter:creator content="@psdbatools">
2828
<meta name=twitter:title content="dbatools docs: Add-DbaComputerCertificate">
2929
<meta property="twitter:site" content="@psdbatools" />
@@ -145,7 +145,7 @@
145145
}
146146
$(document).ready(function () {
147147
function render_doc(doc_to_render, examples_mode) {
148-
148+
149149
$("#rendered h5").each(function (i, el) {
150150
if ($(el).text().startsWith('-')) {
151151
$(el).addClass('param')
@@ -180,7 +180,7 @@
180180
}
181181

182182

183-
//not all code is a block
183+
//not all code is a block
184184
$("#rendered h3[id*='-parameters']").nextAll().find('code').addClass('hljs-inline')
185185
$('#rendered #description').nextUntil('#rendered #syntax').find('code').addClass('hljs-inline')
186186
}
@@ -393,7 +393,7 @@
393393

394394
<nav class="navbar navbar-expand-md customnav">
395395
<a href="https://docs.dbatools.io/" class="navbar-brand" rel="home" itemprop="url">
396-
<img width="265" height="64" src="https://dbatools.io/images/dbatools-docs.png"
396+
<img width="265" height="64" src="https://dbatools.io/wp-content/uploads/2018/09/dbatools-docs.png"
397397
class="custom-logo" alt="dbatools" itemprop="logo" scale="0">
398398
</a>
399399
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarCollapse"
@@ -488,6 +488,7 @@ <h2 id="synopsis">Synopsis</h2>
488488
<p>Imports X.509 certificates into the Windows certificate store on local or remote computers.</p>
489489
<h2 id="description">Description</h2>
490490
<p>Imports X.509 certificates (including password-protected .pfx files with private keys) into the specified Windows certificate store on one or more computers. This function is essential for SQL Server TLS/SSL encryption setup, Availability Group certificate requirements, and Service Broker security configurations.</p>
491+
<p>When importing PFX files, the function imports the entire certificate chain, including intermediate certificates. This ensures proper certificate validation and prevents issues when using certificates with Set-DbaNetworkCertificate or other certificate-dependent operations.</p>
491492
<p>The function handles both certificate files from disk and certificate objects from the pipeline, supports remote installation via PowerShell remoting, and allows you to control import behavior through various flags like exportable/non-exportable private keys. By default, certificates are installed to the LocalMachine\My (Personal) store with exportable and persistent private keys, which is the standard location for SQL Server service certificates.</p>
492493
<h2 id="syntax">Syntax</h2>
493494
<pre><code>Add-DbaComputerCertificate
@@ -524,6 +525,13 @@ <h5 id="example-4">Example: 4</h5>
524525
<pre><code>PS C:\&gt; Add-DbaComputerCertificate -ComputerName sql01 -Path C:\temp\sql01.pfx -Confirm:$false -Flag NonExportable
525526
</code></pre>
526527
<p>Adds the local C:\temp\sql01.pfx to sql01's LocalMachine\My (Personal) certificate store and marks the private key as non-exportable. Skips confirmation prompt.<br></p>
528+
<h5 id="example-5">Example: 5</h5>
529+
<pre><code>PS C:\&gt; $password = Read-Host &quot;Enter the SSL Certificate Password&quot; -AsSecureString
530+
PS C:\&gt; Add-DbaComputerCertificate -ComputerName sql01 -Path C:\cert\fullchain.pfx -SecurePassword $password
531+
PS C:\&gt; Get-DbaComputerCertificate -ComputerName sql01 | Where-Object Subject -match &quot;letsencrypt&quot; | Set-DbaNetworkCertificate -SqlInstance sql01
532+
</code></pre>
533+
<p>Imports a Let's Encrypt certificate with the full chain (including intermediate certificates) from a PFX file, then configures SQL Server to use it. The full chain import ensures that <br>
534+
Set-DbaNetworkCertificate can properly set permissions on the certificate.<br></p>
527535
<h3 id="optional-parameters">Optional Parameters</h3>
528536
<h5 id="computername">-ComputerName</h5>
529537
<p>The target computer or computers where certificates will be installed. Accepts server names, FQDNs, or IP addresses.<br />
@@ -736,7 +744,7 @@ <h5 id="flag">-Flag</h5>
736744
Exportable<br />
737745
Imported keys are marked as exportable.<br />
738746
NonExportable<br />
739-
Expliictly mark keys as nonexportable.<br />
747+
Explicitly mark keys as nonexportable.<br />
740748
PersistKeySet<br />
741749
The key associated with a PFX file is persisted when importing a certificate.<br />
742750
UserProtected<br />

0 commit comments

Comments
 (0)