Skip to content

Commit cfbd1cd

Browse files
potatoqualiteegithub-actions[bot]
authored andcommitted
refreshing docs pages
1 parent 128ebfa commit cfbd1cd

13 files changed

+964
-735
lines changed

Copy-DbaCredential.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -612,7 +612,8 @@ <h5 id="sourcesqlcredential">-SourceSqlCredential</h5>
612612
</tbody>
613613
</table>
614614
<h5 id="credential">-Credential</h5>
615-
<p>This command requires access to the Windows OS via PowerShell remoting. Use this credential to connect to Windows using alternative credentials.<br></p>
615+
<p>Login to the target OS using alternative credentials. Accepts credential objects (Get-Credential)<br />
616+
Only used when passwords are being exported, as it requires access to the Windows OS via PowerShell remoting to decrypt the passwords.<br></p>
616617
<table>
617618
<thead>
618619
<tr>

Copy-DbaDbMail.html

Lines changed: 49 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -491,20 +491,24 @@ <h2 id="description">Description</h2>
491491
<p>Database Mail is commonly used for automated alerts, backup notifications, job failure reports, and maintenance notifications. This function saves significant manual configuration time when setting up new servers, standardizing mail configurations across environments, or migrating to new hardware.</p>
492492
<p>The function preserves all SMTP authentication details including encrypted passwords, handles name conflicts with optional force replacement, and can enable Database Mail on the destination if it's enabled on the source. You can migrate specific component types or the entire configuration in one operation.</p>
493493
<h2 id="syntax">Syntax</h2>
494-
<pre><code>Copy-DbaDbMail -Source &lt;DbaInstanceParameter&gt; -Destination &lt;DbaInstanceParameter[]&gt;
494+
<pre><code>Copy-DbaDbMail -Source &lt;DbaInstanceParameter&gt;
495495
[-SourceSqlCredential &lt;PSCredential&gt;]
496+
-Destination &lt;DbaInstanceParameter[]&gt;
496497
[-DestinationSqlCredential &lt;PSCredential&gt;]
498+
[-Credential &lt;PSCredential&gt;]
497499
[-ExcludePassword]
498500
[-Force]
499501
[-EnableException]
500502
[-WhatIf]
501503
[-Confirm]
502504
[&lt;CommonParameters&gt;]
503505

504-
Copy-DbaDbMail -Source &lt;DbaInstanceParameter&gt; -Destination &lt;DbaInstanceParameter[]&gt;
505-
[-Type &lt;String[]&gt;]
506+
Copy-DbaDbMail -Source &lt;DbaInstanceParameter&gt;
506507
[-SourceSqlCredential &lt;PSCredential&gt;]
508+
-Destination &lt;DbaInstanceParameter[]&gt;
507509
[-DestinationSqlCredential &lt;PSCredential&gt;]
510+
[-Credential &lt;PSCredential&gt;]
511+
[-Type &lt;String[]&gt;]
508512
[-ExcludePassword]
509513
[-Force]
510514
[-EnableException]
@@ -592,10 +596,10 @@ <h5 id="destination">-Destination</h5>
592596
</tbody>
593597
</table>
594598
<h3 id="optional-parameters">Optional Parameters</h3>
595-
<h5 id="type">-Type</h5>
596-
<p>Limits migration to specific Database Mail component types instead of copying everything. Choose 'ConfigurationValues' for global settings like retry attempts and file size limits, 'Profiles' for<br />
597-
mail profile definitions, 'Accounts' for SMTP account configurations, or 'MailServers' for SMTP server details.<br />
598-
Use this when you only need to sync specific components or when troubleshooting individual Database Mail layers.<br></p>
599+
<h5 id="sourcesqlcredential">-SourceSqlCredential</h5>
600+
<p>Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).<br />
601+
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.<br />
602+
For MFA support, please use Connect-DbaInstance.<br></p>
599603
<table>
600604
<thead>
601605
<tr>
@@ -620,13 +624,9 @@ <h5 id="type">-Type</h5>
620624
<td>Default Value</td>
621625
<td></td>
622626
</tr>
623-
<tr>
624-
<td>Accepted Values</td>
625-
<td>ConfigurationValues,Profiles,Accounts,MailServers</td>
626-
</tr>
627627
</tbody>
628628
</table>
629-
<h5 id="sourcesqlcredential">-SourceSqlCredential</h5>
629+
<h5 id="destinationsqlcredential">-DestinationSqlCredential</h5>
630630
<p>Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).<br />
631631
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.<br />
632632
For MFA support, please use Connect-DbaInstance.<br></p>
@@ -656,10 +656,39 @@ <h5 id="sourcesqlcredential">-SourceSqlCredential</h5>
656656
</tr>
657657
</tbody>
658658
</table>
659-
<h5 id="destinationsqlcredential">-DestinationSqlCredential</h5>
660-
<p>Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).<br />
661-
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.<br />
662-
For MFA support, please use Connect-DbaInstance.<br></p>
659+
<h5 id="credential">-Credential</h5>
660+
<p>Login to the target OS using alternative credentials. Accepts credential objects (Get-Credential)<br />
661+
Only used when passwords are being exported, as it requires access to the Windows OS via PowerShell remoting to decrypt the passwords.<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></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>
688+
<h5 id="type">-Type</h5>
689+
<p>Limits migration to specific Database Mail component types instead of copying everything. Choose 'ConfigurationValues' for global settings like retry attempts and file size limits, 'Profiles' for<br />
690+
mail profile definitions, 'Accounts' for SMTP account configurations, or 'MailServers' for SMTP server details.<br />
691+
Use this when you only need to sync specific components or when troubleshooting individual Database Mail layers.<br></p>
663692
<table>
664693
<thead>
665694
<tr>
@@ -684,6 +713,10 @@ <h5 id="destinationsqlcredential">-DestinationSqlCredential</h5>
684713
<td>Default Value</td>
685714
<td></td>
686715
</tr>
716+
<tr>
717+
<td>Accepted Values</td>
718+
<td>ConfigurationValues,Profiles,Accounts,MailServers</td>
719+
</tr>
687720
</tbody>
688721
</table>
689722
<h5 id="excludepassword">-ExcludePassword</h5>

Copy-DbaLinkedServer.html

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -496,6 +496,7 @@ <h2 id="syntax">Syntax</h2>
496496
[[-SourceSqlCredential] &lt;PSCredential&gt;]
497497
[-Destination] &lt;DbaInstanceParameter[]&gt;
498498
[[-DestinationSqlCredential] &lt;PSCredential&gt;]
499+
[[-Credential] &lt;PSCredential&gt;]
499500
[[-LinkedServer] &lt;Object[]&gt;]
500501
[[-ExcludeLinkedServer] &lt;Object[]&gt;]
501502
[-UpgradeSqlClient]
@@ -636,6 +637,35 @@ <h5 id="destinationsqlcredential">-DestinationSqlCredential</h5>
636637
</tr>
637638
</tbody>
638639
</table>
640+
<h5 id="credential">-Credential</h5>
641+
<p>Login to the target OS using alternative credentials. Accepts credential objects (Get-Credential)<br />
642+
Only used when passwords are being exported, as it requires access to the Windows OS via PowerShell remoting to decrypt the passwords.<br></p>
643+
<table>
644+
<thead>
645+
<tr>
646+
<th></th>
647+
<th></th>
648+
</tr>
649+
</thead>
650+
<tbody>
651+
<tr>
652+
<td>Alias</td>
653+
<td></td>
654+
</tr>
655+
<tr>
656+
<td>Required</td>
657+
<td>False</td>
658+
</tr>
659+
<tr>
660+
<td>Pipeline</td>
661+
<td>false</td>
662+
</tr>
663+
<tr>
664+
<td>Default Value</td>
665+
<td></td>
666+
</tr>
667+
</tbody>
668+
</table>
639669
<h5 id="linkedserver">-LinkedServer</h5>
640670
<p>Specifies which linked servers to copy from the source instance. Accepts an array of linked server names.<br />
641671
Use this when you only need to migrate specific linked servers rather than all of them.<br />

Export-DbaCredential.html

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -494,6 +494,7 @@ <h2 id="syntax">Syntax</h2>
494494
<pre><code>Export-DbaCredential
495495
[[-SqlInstance] &lt;DbaInstanceParameter[]&gt;]
496496
[[-SqlCredential] &lt;PSCredential&gt;]
497+
[[-Credential] &lt;PSCredential&gt;]
497498
[[-Path] &lt;String&gt;]
498499
[[-FilePath] &lt;String&gt;]
499500
[[-Identity] &lt;String[]&gt;]
@@ -570,6 +571,35 @@ <h5 id="sqlcredential">-SqlCredential</h5>
570571
</tr>
571572
</tbody>
572573
</table>
574+
<h5 id="credential">-Credential</h5>
575+
<p>Login to the target OS using alternative credentials. Accepts credential objects (Get-Credential)<br />
576+
Only used when passwords are being exported, as it requires access to the Windows OS via PowerShell remoting to decrypt the passwords.<br></p>
577+
<table>
578+
<thead>
579+
<tr>
580+
<th></th>
581+
<th></th>
582+
</tr>
583+
</thead>
584+
<tbody>
585+
<tr>
586+
<td>Alias</td>
587+
<td></td>
588+
</tr>
589+
<tr>
590+
<td>Required</td>
591+
<td>False</td>
592+
</tr>
593+
<tr>
594+
<td>Pipeline</td>
595+
<td>false</td>
596+
</tr>
597+
<tr>
598+
<td>Default Value</td>
599+
<td></td>
600+
</tr>
601+
</tbody>
602+
</table>
573603
<h5 id="path">-Path</h5>
574604
<p>Specifies the directory where the exported T-SQL script file will be saved. Defaults to the configured DbatoolsExport path.<br />
575605
Use this when you want to control where credential scripts are stored for organization or compliance requirements.<br></p>

Export-DbaLinkedServer.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -609,7 +609,8 @@ <h5 id="sqlcredential">-SqlCredential</h5>
609609
</tbody>
610610
</table>
611611
<h5 id="credential">-Credential</h5>
612-
<p>Login to the target OS using alternative linked servers. Accepts credential objects (Get-Credential)<br></p>
612+
<p>Login to the target OS using alternative credentials. Accepts credential objects (Get-Credential)<br />
613+
Only used when passwords are being exported, as it requires access to the Windows OS via PowerShell remoting to decrypt the passwords.<br></p>
613614
<table>
614615
<thead>
615616
<tr>

Install-DbaMaintenanceSolution.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1230,7 +1230,7 @@ <h5 id="checksum">-CheckSum</h5>
12301230
</tbody>
12311231
</table>
12321232
<h5 id="modificationlevel">-ModificationLevel</h5>
1233-
<p>Specifies minimum modification percentage required before ChangeBackupType converts a differential or log backup to full backup.<br />
1233+
<p>Specifies minimum modification percentage required before ChangeBackupType converts a differential backup to full backup.<br />
12341234
Valid range: 0-100. Use this with ChangeBackupType to control when backup type changes occur based on data modification levels.<br />
12351235
Only applies when InstallJobs is specified.<br></p>
12361236
<table>

New-DbaComputerCertificate.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -488,7 +488,7 @@ <h2 id="synopsis">Synopsis</h2>
488488
<p>Creates a new computer certificate useful for Forcing Encryption</p>
489489
<h2 id="description">Description</h2>
490490
<p>Creates a new computer certificate - self-signed or signed by an Active Directory CA, using the Web Server certificate.</p>
491-
<p>By default, a key with a length of 1024 and a friendly name of the machines FQDN is generated.</p>
491+
<p>By default, a key with a length of 2048 bits and a friendly name of &quot;SQL Server&quot; is generated.</p>
492492
<p>This command was originally intended to help automate the process so that SSL certificates can be available for enforcing encryption on connections.</p>
493493
<p>It makes a lot of assumptions - namely, that your account is allowed to auto-enroll and that you have permission to do everything it needs to do ;)</p>
494494
<p>References:<br />
@@ -526,11 +526,11 @@ <h2 id="examples">Examples</h2>
526526
<h5 id="example-1">Example: 1</h5>
527527
<pre><code>PS C:\&gt; New-DbaComputerCertificate
528528
</code></pre>
529-
<p>Creates a computer certificate signed by the local domain CA for the local machine with the keylength of 1024.<br></p>
529+
<p>Creates a computer certificate signed by the local domain CA for the local machine with the keylength of 2048 and SHA-256 hashing.<br></p>
530530
<h5 id="example-2">Example: 2</h5>
531531
<pre><code>PS C:\&gt; New-DbaComputerCertificate -ComputerName Server1
532532
</code></pre>
533-
<p>Creates a computer certificate signed by the local domain CA <em>on the local machine</em> for server1 with the keylength of 1024.<br>
533+
<p>Creates a computer certificate signed by the local domain CA <em>on the local machine</em> for server1 with the keylength of 2048 and SHA-256 hashing.<br>
534534
The certificate is then copied to the new machine over WinRM and imported.<br></p>
535535
<h5 id="example-3">Example: 3</h5>
536536
<pre><code>PS C:\&gt; New-DbaComputerCertificate -ComputerName sqla, sqlb -ClusterInstanceName sqlcluster -KeyLength 4096
@@ -790,8 +790,8 @@ <h5 id="certificatetemplate">-CertificateTemplate</h5>
790790
</table>
791791
<h5 id="keylength">-KeyLength</h5>
792792
<p>Specifies the RSA key size in bits for the certificate's private key.<br />
793-
Defaults to 1024 bits, though 2048 or 4096 bits provide better security for production environments.<br />
794-
Longer keys provide stronger encryption but may slightly impact performance during SSL handshakes.<br></p>
793+
Defaults to 2048 bits which meets current industry security standards for production environments.<br />
794+
4096 bits can be used for high-security environments, though it may slightly impact performance during SSL handshakes.<br></p>
795795
<table>
796796
<thead>
797797
<tr>
@@ -814,7 +814,7 @@ <h5 id="keylength">-KeyLength</h5>
814814
</tr>
815815
<tr>
816816
<td>Default Value</td>
817-
<td>1024</td>
817+
<td>2048</td>
818818
</tr>
819819
</tbody>
820820
</table>
@@ -1005,8 +1005,8 @@ <h5 id="enableexception">-EnableException</h5>
10051005
</table>
10061006
<h5 id="hashalgorithm">-HashAlgorithm</h5>
10071007
<p>Specifies the cryptographic hash algorithm used for certificate signing.<br />
1008-
Defaults to &quot;sha1&quot; for compatibility, though &quot;Sha256&quot; or higher is recommended for production security.<br />
1009-
Modern browsers and applications prefer SHA-256 or higher; avoid MD5 and MD4 for security reasons.<br></p>
1008+
Defaults to &quot;Sha256&quot; which meets current industry security standards for production environments.<br />
1009+
SHA-384 and SHA-512 provide even stronger security for high-security environments.<br></p>
10101010
<table>
10111011
<thead>
10121012
<tr>
@@ -1029,11 +1029,11 @@ <h5 id="hashalgorithm">-HashAlgorithm</h5>
10291029
</tr>
10301030
<tr>
10311031
<td>Default Value</td>
1032-
<td>sha1</td>
1032+
<td>Sha256</td>
10331033
</tr>
10341034
<tr>
10351035
<td>Accepted Values</td>
1036-
<td>Sha256,sha384,sha512,sha1,md5,md4,md2</td>
1036+
<td>Sha256,sha384,sha512</td>
10371037
</tr>
10381038
</tbody>
10391039
</table>

Restore-DbaDatabase.html

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -640,7 +640,7 @@ <h5 id="example-6">Example: 6</h5>
640640
<p>Scans all the files in c:\backups and then restores them onto the SQL Server Instance server1\instance1, placing data files<br>
641641
c:\DataFiles and all the log files into c:\LogFiles<br></p>
642642
<h5 id="example-7">Example: 7</h5>
643-
<pre><code>PS C:\&gt; Restore-DbaDatabase -SqlInstance server1\instance1 -Path http://demo.blob.core.windows.net/backups/dbbackup.bak -StorageCredential MyAzureCredential
643+
<pre><code>PS C:\&gt; Restore-DbaDatabase -SqlInstance server1\instance1 -Path http://demo.blob.core.windows.net/backups/dbbackup.bak -AzureCredential MyAzureCredential
644644
</code></pre>
645645
<p>Will restore the backup held at <a href="http://demo.blob.core.windows.net/backups/dbbackup.bak">http://demo.blob.core.windows.net/backups/dbbackup.bak</a> to server1\instance1. The connection to Azure will be made using the<br>
646646
credential MyAzureCredential held on instance Server1\instance1<br></p>
@@ -730,6 +730,18 @@ <h5 id="example-18">Example: 18</h5>
730730
</code></pre>
731731
<p>Restores the backups from \ServerName\ShareName\File as database, stops before the first 'OvernightStart' mark that occurs after '21:00 10/05/2020'.<br>
732732
Note that Date time needs to be specified in your local SQL Server culture<br></p>
733+
<h5 id="example-19">Example: 19</h5>
734+
<pre><code>PS C:\&gt; # Restore from S3 storage folder (SQL Server 2022+)
735+
PS C:\&gt; # First, enumerate S3 bucket contents using AWS PowerShell module - You need to be authenticated!
736+
PS C:\&gt; $s3Files = Get-S3Object -BucketName &quot;mybucket&quot; -KeyPrefix &quot;backups/AdventureWorks/&quot; -Region &quot;us-west-2&quot;
737+
PS C:\&gt; $backupPaths = $s3Files | Where-Object { $_.Key -match '\.(bak|trn|dif)$' } | ForEach-Object { &quot;s3://mybucket.s3.us-west-2.amazonaws.com/$($_.Key)&quot; }
738+
PS C:\&gt;
739+
PS C:\&gt; # Then restore using the enumerated file paths
740+
PS C:\&gt; Restore-DbaDatabase -SqlInstance sql2022 -Path $backupPaths -StorageCredential MyS3Credential
741+
</code></pre>
742+
<p>Demonstrates the recommended workflow for restoring from S3 storage. Since SQL Server cannot enumerate S3 bucket contents via T-SQL, you must first use PowerShell's Get-S3Object cmdlet to list backup <br>
743+
files, then pass the full S3 URLs to Restore-DbaDatabase.<br>
744+
The StorageCredential parameter should reference a SQL Server credential configured for S3 access.<br></p>
733745
<h3 id="required-parameters">Required Parameters</h3>
734746
<h5 id="sqlinstance">-SqlInstance</h5>
735747
<p>The target SQL Server instance. <br></p>
@@ -760,9 +772,11 @@ <h5 id="sqlinstance">-SqlInstance</h5>
760772
</tbody>
761773
</table>
762774
<h5 id="path">-Path</h5>
763-
<p>Specifies the location of backup files to restore from, supporting local drives, UNC paths, or Azure blob storage URLs.<br />
775+
<p>Specifies the location of backup files to restore from, supporting local drives, UNC paths, Azure blob storage URLs, or S3 URLs.<br />
764776
Use this when you need to restore from a specific backup location or when piping backup files from Get-ChildItem.<br />
765-
Accepts multiple comma-separated paths for complex restore scenarios spanning multiple locations. <br></p>
777+
Accepts multiple comma-separated paths for complex restore scenarios spanning multiple locations.<br />
778+
For S3 storage (SQL Server 2022+): S3 bucket contents cannot be enumerated using T-SQL. You must provide explicit file paths or use PowerShell's Get-S3Object cmdlet (from AWS.Tools.S3 module) to<br />
779+
retrieve the list of backup files first, then pass them to this command. See examples for S3 usage patterns. <br></p>
766780
<table>
767781
<thead>
768782
<tr>

0 commit comments

Comments
 (0)