Skip to content

Commit c43d140

Browse files
potatoqualiteegithub-actions[bot]
potatoqualitee
authored and
github-actions[bot]
committed
refreshing docs pages
1 parent 06944d1 commit c43d140

15 files changed

+1021
-723
lines changed

‎Backup-DbaDbCertificate.html

+32
Original file line numberDiff line numberDiff line change
@@ -495,6 +495,7 @@ <h2 id="syntax">Syntax</h2>
495495
[-DecryptionPassword &lt;SecureString&gt;]
496496
[-Path &lt;FileInfo&gt;]
497497
[-Suffix &lt;String&gt;]
498+
[-FileBaseName &lt;String&gt;]
498499
[-EnableException]
499500
[-WhatIf]
500501
[-Confirm]
@@ -509,6 +510,7 @@ <h2 id="syntax">Syntax</h2>
509510
[-DecryptionPassword &lt;SecureString&gt;]
510511
[-Path &lt;FileInfo&gt;]
511512
[-Suffix &lt;String&gt;]
513+
[-FileBaseName &lt;String&gt;]
512514
[-EnableException]
513515
[-WhatIf]
514516
[-Confirm]
@@ -520,6 +522,7 @@ <h2 id="syntax">Syntax</h2>
520522
[-DecryptionPassword &lt;SecureString&gt;]
521523
[-Path &lt;FileInfo&gt;]
522524
[-Suffix &lt;String&gt;]
525+
[-FileBaseName &lt;String&gt;]
523526
[-InputObject &lt;Certificate[]&gt;]
524527
[-EnableException]
525528
[-WhatIf]
@@ -829,6 +832,35 @@ <h5 id="suffix">-Suffix</h5>
829832
</tr>
830833
</tbody>
831834
</table>
835+
<h5 id="filebasename">-FileBaseName</h5>
836+
<p>Override the default naming convention with a fixed name for the certificate and private key file name, useful when exporting a single certificate.<br />
837+
&quot;.cer&quot; will be appended to the certificate file name and &quot;.pvk&quot; will be appended to the private key file name.<br></p>
838+
<table>
839+
<thead>
840+
<tr>
841+
<th></th>
842+
<th></th>
843+
</tr>
844+
</thead>
845+
<tbody>
846+
<tr>
847+
<td>Alias</td>
848+
<td></td>
849+
</tr>
850+
<tr>
851+
<td>Required</td>
852+
<td>False</td>
853+
</tr>
854+
<tr>
855+
<td>Pipeline</td>
856+
<td>false</td>
857+
</tr>
858+
<tr>
859+
<td>Default Value</td>
860+
<td></td>
861+
</tr>
862+
</tbody>
863+
</table>
832864
<h5 id="inputobject">-InputObject</h5>
833865
<p>Enables piping from Get-DbaDbCertificate<br></p>
834866
<table>

‎Backup-DbaDbMasterKey.html

+30
Original file line numberDiff line numberDiff line change
@@ -497,6 +497,7 @@ <h2 id="syntax">Syntax</h2>
497497
[[-ExcludeDatabase] &lt;String[]&gt;]
498498
[[-SecurePassword] &lt;SecureString&gt;]
499499
[[-Path] &lt;String&gt;]
500+
[[-FileBaseName] &lt;String&gt;]
500501
[[-InputObject] &lt;Database[]&gt;]
501502
[-EnableException]
502503
[-WhatIf]
@@ -719,6 +720,35 @@ <h5 id="path">-Path</h5>
719720
</tr>
720721
</tbody>
721722
</table>
723+
<h5 id="filebasename">-FileBaseName</h5>
724+
<p>Override the default naming convention with a fixed name for the database master key, useful when exporting a single one.<br />
725+
&quot;.key&quot; will be appended to the filename.<br></p>
726+
<table>
727+
<thead>
728+
<tr>
729+
<th></th>
730+
<th></th>
731+
</tr>
732+
</thead>
733+
<tbody>
734+
<tr>
735+
<td>Alias</td>
736+
<td></td>
737+
</tr>
738+
<tr>
739+
<td>Required</td>
740+
<td>False</td>
741+
</tr>
742+
<tr>
743+
<td>Pipeline</td>
744+
<td>false</td>
745+
</tr>
746+
<tr>
747+
<td>Default Value</td>
748+
<td></td>
749+
</tr>
750+
</tbody>
751+
</table>
722752
<h5 id="inputobject">-InputObject</h5>
723753
<p>Database object piped in from Get-DbaDatabase<br></p>
724754
<table>

‎Backup-DbaServiceMasterKey.html

+30
Original file line numberDiff line numberDiff line change
@@ -495,6 +495,7 @@ <h2 id="syntax">Syntax</h2>
495495
[[-KeyCredential] &lt;PSCredential&gt;]
496496
[[-SecurePassword] &lt;SecureString&gt;]
497497
[[-Path] &lt;String&gt;]
498+
[[-FileBaseName] &lt;String&gt;]
498499
[-EnableException]
499500
[-WhatIf]
500501
[-Confirm]
@@ -661,6 +662,35 @@ <h5 id="path">-Path</h5>
661662
</tr>
662663
</tbody>
663664
</table>
665+
<h5 id="filebasename">-FileBaseName</h5>
666+
<p>Override the default naming convention with a fixed name for the service master key, useful when exporting a single one.<br />
667+
&quot;.key&quot; will be appended to the filename.<br></p>
668+
<table>
669+
<thead>
670+
<tr>
671+
<th></th>
672+
<th></th>
673+
</tr>
674+
</thead>
675+
<tbody>
676+
<tr>
677+
<td>Alias</td>
678+
<td></td>
679+
</tr>
680+
<tr>
681+
<td>Required</td>
682+
<td>False</td>
683+
</tr>
684+
<tr>
685+
<td>Pipeline</td>
686+
<td>false</td>
687+
</tr>
688+
<tr>
689+
<td>Default Value</td>
690+
<td></td>
691+
</tr>
692+
</tbody>
693+
</table>
664694
<h5 id="enableexception">-EnableException</h5>
665695
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
666696
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />

‎Disable-DbaTraceFlag.html

+59-1
Original file line numberDiff line numberDiff line change
@@ -495,6 +495,8 @@ <h2 id="syntax">Syntax</h2>
495495
[[-SqlCredential] &lt;PSCredential&gt;]
496496
[-TraceFlag] &lt;Int32[]&gt;
497497
[-EnableException]
498+
[-WhatIf]
499+
[-Confirm]
498500
[&lt;CommonParameters&gt;]
499501

500502
</code></pre>
@@ -535,7 +537,7 @@ <h5 id="sqlinstance">-SqlInstance</h5>
535537
</tbody>
536538
</table>
537539
<h5 id="traceflag">-TraceFlag</h5>
538-
<p>Trace flag number to enable globally <br></p>
540+
<p>Trace flag number to disable globally <br></p>
539541
<table>
540542
<thead>
541543
<tr>
@@ -623,6 +625,62 @@ <h5 id="enableexception">-EnableException</h5>
623625
</tr>
624626
</tbody>
625627
</table>
628+
<h5 id="whatif">-WhatIf</h5>
629+
<p>Shows what would happen if the command were to run. No actions are actually performed.<br></p>
630+
<table>
631+
<thead>
632+
<tr>
633+
<th></th>
634+
<th></th>
635+
</tr>
636+
</thead>
637+
<tbody>
638+
<tr>
639+
<td>Alias</td>
640+
<td>wi</td>
641+
</tr>
642+
<tr>
643+
<td>Required</td>
644+
<td>False</td>
645+
</tr>
646+
<tr>
647+
<td>Pipeline</td>
648+
<td>false</td>
649+
</tr>
650+
<tr>
651+
<td>Default Value</td>
652+
<td></td>
653+
</tr>
654+
</tbody>
655+
</table>
656+
<h5 id="confirm">-Confirm</h5>
657+
<p>Prompts you for confirmation before executing any changing operations within the command.<br></p>
658+
<table>
659+
<thead>
660+
<tr>
661+
<th></th>
662+
<th></th>
663+
</tr>
664+
</thead>
665+
<tbody>
666+
<tr>
667+
<td>Alias</td>
668+
<td>cf</td>
669+
</tr>
670+
<tr>
671+
<td>Required</td>
672+
<td>False</td>
673+
</tr>
674+
<tr>
675+
<td>Pipeline</td>
676+
<td>false</td>
677+
</tr>
678+
<tr>
679+
<td>Default Value</td>
680+
<td></td>
681+
</tr>
682+
</tbody>
683+
</table>
626684
<p> </p>
627685

628686
</div> <!-- rendered -->

‎Enable-DbaTraceFlag.html

+58
Original file line numberDiff line numberDiff line change
@@ -495,6 +495,8 @@ <h2 id="syntax">Syntax</h2>
495495
[[-SqlCredential] &lt;PSCredential&gt;]
496496
[-TraceFlag] &lt;Int32[]&gt;
497497
[-EnableException]
498+
[-WhatIf]
499+
[-Confirm]
498500
[&lt;CommonParameters&gt;]
499501

500502
</code></pre>
@@ -627,6 +629,62 @@ <h5 id="enableexception">-EnableException</h5>
627629
</tr>
628630
</tbody>
629631
</table>
632+
<h5 id="whatif">-WhatIf</h5>
633+
<p>Shows what would happen if the command were to run. No actions are actually performed.<br></p>
634+
<table>
635+
<thead>
636+
<tr>
637+
<th></th>
638+
<th></th>
639+
</tr>
640+
</thead>
641+
<tbody>
642+
<tr>
643+
<td>Alias</td>
644+
<td>wi</td>
645+
</tr>
646+
<tr>
647+
<td>Required</td>
648+
<td>False</td>
649+
</tr>
650+
<tr>
651+
<td>Pipeline</td>
652+
<td>false</td>
653+
</tr>
654+
<tr>
655+
<td>Default Value</td>
656+
<td></td>
657+
</tr>
658+
</tbody>
659+
</table>
660+
<h5 id="confirm">-Confirm</h5>
661+
<p>Prompts you for confirmation before executing any changing operations within the command.<br></p>
662+
<table>
663+
<thead>
664+
<tr>
665+
<th></th>
666+
<th></th>
667+
</tr>
668+
</thead>
669+
<tbody>
670+
<tr>
671+
<td>Alias</td>
672+
<td>cf</td>
673+
</tr>
674+
<tr>
675+
<td>Required</td>
676+
<td>False</td>
677+
</tr>
678+
<tr>
679+
<td>Pipeline</td>
680+
<td>false</td>
681+
</tr>
682+
<tr>
683+
<td>Default Value</td>
684+
<td></td>
685+
</tr>
686+
</tbody>
687+
</table>
630688
<p> </p>
631689

632690
</div> <!-- rendered -->

‎Find-DbaAgentJob.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -531,7 +531,7 @@ <h5 id="example-5">Example: 5</h5>
531531
</code></pre>
532532
<p>Finds all failed job then starts them. Consider using a -WhatIf at the end of Start-DbaAgentJob to see what it'll do first<br></p>
533533
<h5 id="example-6">Example: 6</h5>
534-
<pre><code>PS C:\&gt; Find-DbaAgentJob -SqlInstance Dev01 -LastUsed 10 -Exclude &quot;Yearly - RollUp Workload&quot;, &quot;SMS - Notification&quot;
534+
<pre><code>PS C:\&gt; Find-DbaAgentJob -SqlInstance Dev01 -LastUsed 10 -ExcludeJobName &quot;Yearly - RollUp Workload&quot;, &quot;SMS - Notification&quot;
535535
</code></pre>
536536
<p>Returns all agent jobs that have not ran in the last 10 days ignoring jobs &quot;Yearly - RollUp Workload&quot; and &quot;SMS - Notification&quot;<br></p>
537537
<h5 id="example-7">Example: 7</h5>

‎Get-DbaDbBackupHistory.html

+6-4
Original file line numberDiff line numberDiff line change
@@ -552,7 +552,7 @@ <h5 id="example-2">Example: 2</h5>
552552
<p>Get-DbaDbBackupHistory -SqlInstance SqlInstance2014a -SqlCredential $cred<br>
553553
Does the same as above but connect to SqlInstance2014a as SQL user &quot;sqladmin&quot;<br></p>
554554
<h5 id="example-3">Example: 3</h5>
555-
<pre><code>PS C:\&gt; Get-DbaDbBackupHistory -SqlInstance SqlInstance2014a -Database db1, db2 -Since '2016-07-01 10:47:00'
555+
<pre><code>PS C:\&gt; Get-DbaDbBackupHistory -SqlInstance SqlInstance2014a -Database db1, db2 -Since ([DateTime]'2016-07-01 10:47:00')
556556
</code></pre>
557557
<p>Returns backup information only for databases db1 and db2 on SqlInstance2014a since July 1, 2016 at 10:47 AM.<br></p>
558558
<h5 id="example-4">Example: 4</h5>
@@ -763,8 +763,10 @@ <h5 id="force">-Force</h5>
763763
</tbody>
764764
</table>
765765
<h5 id="since">-Since</h5>
766-
<p>Specifies a starting point for the search for backups. If a DateTime object is passed, that will be used. If a TimeSpan object is passed, that will be added to Get-Date and the resulting value will<br />
767-
be used.<br></p>
766+
<p>Specifies a starting point for the search for backups.<br />
767+
This is compared to the date stored in msdb, which gets stored in the timezone of the running SQL Server instance.<br />
768+
If a DateTime object is passed, that will be used.<br />
769+
If a TimeSpan object is passed, that will be added to Get-Date and the resulting value will be used.<br></p>
768770
<table>
769771
<thead>
770772
<tr>
@@ -787,7 +789,7 @@ <h5 id="since">-Since</h5>
787789
</tr>
788790
<tr>
789791
<td>Default Value</td>
790-
<td>(Get-Date '01/01/1970')</td>
792+
<td>([DateTime]::ParseExact(&quot;1970-01-01&quot;, &quot;yyyy-MM-dd&quot;, [System.Globalization.CultureInfo]::InvariantCulture))</td>
791793
</tr>
792794
</tbody>
793795
</table>

‎Install-DbaMaintenanceSolution.html

+18-4
Original file line numberDiff line numberDiff line change
@@ -537,18 +537,31 @@ <h5 id="example-3">Example: 3</h5>
537537
&gt;&gt; }
538538
&gt;&gt; Install-DbaMaintenanceSolution @params
539539
</code></pre>
540-
<p>Installs Maintenance Solution to myserver in database. Adds Agent Jobs, and if any currently exist, they'll be replaced.<br></p>
540+
<p>Installs Maintenance Solution to myserver in database. Adds Agent Jobs, and if any currently exist, they'll be replaced.<br>
541+
Since the <code>LogToTable</code> switch is enabled, the CommandLog table will be dropped and recreated also.<br>
542+
If the tables relating to <code>InstallParallel</code> are present, they will not be dropped.<br></p>
541543
<h5 id="example-4">Example: 4</h5>
542-
<pre><code>PS C:\&gt; Install-DbaMaintenanceSolution -SqlInstance RES14224 -Database DBA -InstallJobs -BackupLocation &quot;Z:\SQLBackup&quot; -CleanupTime 72 -ReplaceExisting
544+
<pre><code>PS C:\&gt; $params = @{
545+
&gt;&gt; SqlInstance = 'RES14224'
546+
&gt;&gt; Database = 'DBA'
547+
&gt;&gt; InstallJobs = $true
548+
&gt;&gt; BackupLocation = 'Z:\SQLBackup'
549+
&gt;&gt; CleanupTime = 72
550+
&gt;&gt; ReplaceExisting = $true
551+
&gt;&gt; }
552+
PS C:\&gt; Install-DbaMaintenanceSolution @params
543553
</code></pre>
544554
<p>This will drop and then recreate the Ola Hallengren's Solution objects<br>
545555
The cleanup script will drop and recreate:<br></p>
546556
<ul>
547-
<li>TABLE [dbo].[CommandLog]<br></li>
548557
<li>STORED PROCEDURE [dbo].[CommandExecute]<br></li>
549558
<li>STORED PROCEDURE [dbo].[DatabaseBackup]<br></li>
550559
<li>STORED PROCEDURE [dbo].[DatabaseIntegrityCheck]<br></li>
551560
<li>STORED PROCEDURE [dbo].[IndexOptimize]<br>
561+
The tables will not be dropped as the <code>LogToTable</code> and <code>InstallParallel</code> switches are not enabled.<br></li>
562+
<li>[dbo].[CommandLog]<br></li>
563+
<li>[dbo].[Queue]<br></li>
564+
<li>[dbo].[QueueDatabase]<br>
552565
The following SQL Agent jobs will be deleted:<br></li>
553566
<li>'Output File Cleanup'<br></li>
554567
<li>'IndexOptimize - USER_DATABASES'<br></li>
@@ -769,7 +782,8 @@ <h5 id="outputfiledirectory">-OutputFileDirectory</h5>
769782
</tbody>
770783
</table>
771784
<h5 id="replaceexisting">-ReplaceExisting</h5>
772-
<p>If this switch is enabled, objects already present in the target database will be dropped and recreated.<br></p>
785+
<p>If this switch is enabled, objects already present in the target database will be dropped and recreated.<br />
786+
Note - The tables for <code>LogToTable</code> and <code>InstallParallel</code> will only be dropped if those options are also specified.<br></p>
773787
<table>
774788
<thead>
775789
<tr>

0 commit comments

Comments
 (0)