Skip to content

Commit 0cd9d01

Browse files
potatoqualiteegithub-actions[bot]
potatoqualitee
authored and
github-actions[bot]
committed
refreshing docs pages
1 parent 9c46487 commit 0cd9d01

File tree

7 files changed

+780
-821
lines changed

7 files changed

+780
-821
lines changed

‎Get-DbaService.html‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -734,7 +734,9 @@ <h5 id="servicename">-ServiceName</h5>
734734
</table>
735735
<h5 id="advancedproperties">-AdvancedProperties</h5>
736736
<p>Includes additional service properties such as SQL Server version, service pack level, SKU name, and cluster information.<br />
737-
Use this when you need detailed service information for inventory, compliance, or troubleshooting purposes. Note that this adds processing time to the command.<br></p>
737+
Use this when you need detailed service information for inventory, compliance, or troubleshooting purposes. Note that this adds processing time to the command.<br />
738+
This will also output the additional property SqlInstance based on the Clustered and VSName properties for engine services.<br />
739+
Use this property to connect to the correct SQL instance.<br></p>
738740
<table>
739741
<thead>
740742
<tr>

‎Install-DbaSqlPackage.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -496,7 +496,7 @@ <h2 id="description">Description</h2>
496496
</ul>
497497
<p>By default, SqlPackage is installed as a portable ZIP file to the dbatools directory for CurrentUser scope, making it immediately available for database deployment tasks without requiring system-wide installation.<br />
498498
For AllUsers (LocalMachine) scope on Windows, you can use the MSI installer which requires administrative privileges and provides system-wide access.</p>
499-
<p>Writes to $script:PSModuleRoot\bin\sqlpackage by default for CurrentUser scope.</p>
499+
<p>Writes to dbatools data directory by default for CurrentUser scope.</p>
500500
<h2 id="syntax">Syntax</h2>
501501
<pre><code>Install-DbaSqlPackage
502502
[[-Path] &lt;String&gt;]
@@ -516,15 +516,15 @@ <h2 id="examples">Examples</h2>
516516
<h5 id="example-1">Example: 1</h5>
517517
<pre><code>PS C:\&gt; Install-DbaSqlPackage
518518
</code></pre>
519-
<p>Downloads SqlPackage ZIP to the dbatools directory for the current user<br></p>
519+
<p>Downloads SqlPackage ZIP and extracts it to the dbatools directory for the current user<br></p>
520520
<h5 id="example-2">Example: 2</h5>
521521
<pre><code>PS C:\&gt; Install-DbaSqlPackage -Scope AllUsers -Type Msi
522522
</code></pre>
523523
<p>Downloads and installs SqlPackage MSI for all users (requires administrative privileges)<br></p>
524524
<h5 id="example-3">Example: 3</h5>
525525
<pre><code>PS C:\&gt; Install-DbaSqlPackage -Path C:\SqlPackage
526526
</code></pre>
527-
<p>Downloads SqlPackage ZIP to C:\SqlPackage<br></p>
527+
<p>Downloads SqlPackage ZIP and extracts it to C:\SqlPackage<br></p>
528528
<h5 id="example-4">Example: 4</h5>
529529
<pre><code>PS C:\&gt; Install-DbaSqlPackage -LocalFile C:\temp\sqlpackage.zip
530530
</code></pre>

‎Test-DbaDiskAllocation.html‎

Lines changed: 0 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -499,8 +499,6 @@ <h2 id="syntax">Syntax</h2>
499499
[[-SqlCredential] &lt;PSCredential&gt;]
500500
[[-Credential] &lt;PSCredential&gt;]
501501
[-EnableException]
502-
[-WhatIf]
503-
[-Confirm]
504502
[&lt;CommonParameters&gt;]
505503

506504
</code></pre>
@@ -668,62 +666,6 @@ <h5 id="enableexception">-EnableException</h5>
668666
</tr>
669667
</tbody>
670668
</table>
671-
<h5 id="whatif">-WhatIf</h5>
672-
<p>If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.<br></p>
673-
<table>
674-
<thead>
675-
<tr>
676-
<th></th>
677-
<th></th>
678-
</tr>
679-
</thead>
680-
<tbody>
681-
<tr>
682-
<td>Alias</td>
683-
<td>wi</td>
684-
</tr>
685-
<tr>
686-
<td>Required</td>
687-
<td>False</td>
688-
</tr>
689-
<tr>
690-
<td>Pipeline</td>
691-
<td>false</td>
692-
</tr>
693-
<tr>
694-
<td>Default Value</td>
695-
<td></td>
696-
</tr>
697-
</tbody>
698-
</table>
699-
<h5 id="confirm">-Confirm</h5>
700-
<p>If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.<br></p>
701-
<table>
702-
<thead>
703-
<tr>
704-
<th></th>
705-
<th></th>
706-
</tr>
707-
</thead>
708-
<tbody>
709-
<tr>
710-
<td>Alias</td>
711-
<td>cf</td>
712-
</tr>
713-
<tr>
714-
<td>Required</td>
715-
<td>False</td>
716-
</tr>
717-
<tr>
718-
<td>Pipeline</td>
719-
<td>false</td>
720-
</tr>
721-
<tr>
722-
<td>Default Value</td>
723-
<td></td>
724-
</tr>
725-
</tbody>
726-
</table>
727669
<p> </p>
728670

729671
</div> <!-- rendered -->

‎Test-DbaKerberos.html‎

Lines changed: 71 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -472,7 +472,7 @@ <h1 id="test-dbakerberos">Test-DbaKerberos</h1>
472472
<tbody>
473473
<tr>
474474
<td><strong>Author</strong></td>
475-
<td>the dbatools team + Claude</td>
475+
<td>Claude + Andreas Jordan + Chrissy LeMaire</td>
476476
</tr>
477477
<tr>
478478
<td><strong>Availability</strong></td>
@@ -485,34 +485,69 @@ <h1 id="test-dbakerberos">Test-DbaKerberos</h1>
485485
<br>
486486
Want to see the Bill Of Health for this command? Check out <a href="https://dataplat.github.io/boh#Test-DbaKerberos">Test-DbaKerberos</a>.</p>
487487
<h2 id="synopsis">Synopsis</h2>
488-
<p>Tests Kerberos authentication configuration for SQL Server instances by performing comprehensive diagnostic checks</p>
488+
<p>Tests Kerberos authentication configuration for SQL Server instances by performing comprehensive diagnostic checks.</p>
489489
<h2 id="description">Description</h2>
490490
<p>This function performs a comprehensive suite of diagnostic checks to troubleshoot Kerberos authentication issues for SQL Server instances. It addresses the most common causes of Kerberos authentication failures including SPN configuration problems, DNS issues, time synchronization errors, service account configuration, network connectivity problems, and security policy misconfigurations.</p>
491-
<p>The function performs 25+ checks across multiple categories:</p>
491+
<p>The function performs 20 checks across 9 categories (plus additional checks per AG listener):</p>
492+
<p>SPN (1-2+ checks):</p>
492493
<ul>
493-
<li>SPN validation (duplicate detection, format validation, ownership verification)</li>
494-
<li>Time synchronization (client-server and server-DC time comparisons)</li>
495-
<li>DNS resolution (forward/reverse lookups, CNAME detection)</li>
496-
<li>Service account configuration (lock status, delegation settings)</li>
497-
<li>Network connectivity (Kerberos and LDAP port testing)</li>
498-
<li>Security policy validation (encryption types, secure channel)</li>
499-
<li>SQL Server configuration (service account, network protocols)</li>
500-
<li>Authentication verification (current auth scheme validation)</li>
494+
<li>SPN Registration - Verifies required SPNs are registered using Test-DbaSpn</li>
495+
<li>AG Listener SPN - One check per Availability Group listener (if any exist)</li>
501496
</ul>
502-
<p>Each check returns a structured result with status (Pass/Fail/Warning), detailed findings, and actionable remediation recommendations. Use the -Detailed switch for verbose diagnostic output including intermediate check results.</p>
503-
<p>This command is essential for troubleshooting authentication failures, validating Kerberos setup before migrations, performing security audits, and as part of regular maintenance to ensure proper authentication across SQL Server environments.</p>
497+
<p>Time Sync (2 checks):</p>
498+
<ul>
499+
<li>Client-Server time synchronization (5-minute Kerberos threshold)</li>
500+
<li>Server-DC time synchronization</li>
501+
</ul>
502+
<p>DNS (3 checks):</p>
503+
<ul>
504+
<li>Forward lookup verification</li>
505+
<li>Reverse lookup verification</li>
506+
<li>CNAME detection (CNAMEs break Kerberos)</li>
507+
</ul>
508+
<p>Service Account (3 checks):</p>
509+
<ul>
510+
<li>Service account type validation (gMSA, domain account, built-in accounts)</li>
511+
<li>Account lock status in Active Directory</li>
512+
<li>Delegation settings (&quot;sensitive and cannot be delegated&quot; flag)</li>
513+
</ul>
514+
<p>Authentication (1 check):</p>
515+
<ul>
516+
<li>Current authentication scheme (Kerberos vs NTLM)</li>
517+
</ul>
518+
<p>Network (3 checks):</p>
519+
<ul>
520+
<li>Kerberos port TCP/88 connectivity to DC</li>
521+
<li>LDAP port TCP/389 connectivity to DC</li>
522+
<li>Kerberos-Kdc port TCP/464 connectivity to DC</li>
523+
</ul>
524+
<p>Security Policy (3 checks):</p>
525+
<ul>
526+
<li>Kerberos encryption types configuration</li>
527+
<li>Computer secure channel health</li>
528+
<li>Hosts file entries that may override DNS</li>
529+
</ul>
530+
<p>SQL Configuration (2 checks):</p>
531+
<ul>
532+
<li>SQL Server service account configuration</li>
533+
<li>Network protocol configuration (TCP/IP enabled)</li>
534+
</ul>
535+
<p>Client (1 check):</p>
536+
<ul>
537+
<li>Kerberos ticket cache inspection via klist</li>
538+
</ul>
539+
<p>Each check returns a structured result with ComputerName, InstanceName, Check, Category, Status (Pass/Fail/Warning), Details, and Remediation recommendations.</p>
540+
<p>Note: When using -ComputerName instead of -SqlInstance, SQL Server-specific checks (service account, authentication scheme, network protocols) are skipped.</p>
504541
<h2 id="syntax">Syntax</h2>
505542
<pre><code>Test-DbaKerberos -SqlInstance &lt;DbaInstanceParameter[]&gt;
506543
[-SqlCredential &lt;PSCredential&gt;]
507544
[-Credential &lt;PSCredential&gt;]
508-
[-Detailed]
509545
[-EnableException]
510546
[&lt;CommonParameters&gt;]
511547

512548
Test-DbaKerberos -ComputerName &lt;DbaInstanceParameter[]&gt;
513549
[-SqlCredential &lt;PSCredential&gt;]
514550
[-Credential &lt;PSCredential&gt;]
515-
[-Detailed]
516551
[-EnableException]
517552
[&lt;CommonParameters&gt;]
518553

@@ -523,28 +558,36 @@ <h2 id="examples">Examples</h2>
523558
<h5 id="example-1">Example: 1</h5>
524559
<pre><code>PS C:\&gt; Test-DbaKerberos -SqlInstance sql2016
525560
</code></pre>
526-
<p>Performs comprehensive Kerberos diagnostic checks for the sql2016 instance, returning pass/fail status for each check.<br></p>
561+
<p>Performs comprehensive Kerberos diagnostic checks for the sql2016 instance, returning pass/fail/warning status for each check with remediation recommendations.<br></p>
527562
<h5 id="example-2">Example: 2</h5>
528-
<pre><code>PS C:\&gt; Test-DbaKerberos -SqlInstance sql2016 -Detailed
563+
<pre><code>PS C:\&gt; Test-DbaKerberos -SqlInstance sql2016 -SqlCredential (Get-Credential) -Credential (Get-Credential)
529564
</code></pre>
530-
<p>Performs comprehensive Kerberos diagnostic checks with detailed output including verbose findings and intermediate results.<br></p>
565+
<p>Tests Kerberos configuration using SQL credentials to connect to the instance and separate AD credentials for remote WinRM and Active Directory queries.<br></p>
531566
<h5 id="example-3">Example: 3</h5>
532-
<pre><code>PS C:\&gt; Test-DbaKerberos -SqlInstance sql2016, sql2019 -Credential (Get-Credential)
567+
<pre><code>PS C:\&gt; Test-DbaKerberos -SqlInstance sql2016, sql2019
533568
</code></pre>
534-
<p>Tests multiple SQL Server instances using specified credentials for AD queries.<br></p>
569+
<p>Tests multiple SQL Server instances in a single command.<br></p>
535570
<h5 id="example-4">Example: 4</h5>
536-
<pre><code>PS C:\&gt; Test-DbaKerberos -ComputerName SERVER01 -SqlCredential ad\sqldba
571+
<pre><code>PS C:\&gt; Test-DbaKerberos -ComputerName SERVER01 -Credential (Get-Credential)
537572
</code></pre>
538-
<p>Tests Kerberos configuration for all SQL instances on SERVER01 using specified AD credentials.<br></p>
573+
<p>Tests Kerberos configuration at the computer level using specified credentials for WinRM and AD queries. SQL Server-specific checks are skipped.<br></p>
539574
<h5 id="example-5">Example: 5</h5>
540575
<pre><code>PS C:\&gt; Get-DbaRegServer -SqlInstance sqlcentral | Test-DbaKerberos | Where-Object Status -eq &quot;Fail&quot;
541576
</code></pre>
542577
<p>Tests all registered servers and returns only the checks that failed, useful for identifying problems across your environment.<br></p>
578+
<h5 id="example-6">Example: 6</h5>
579+
<pre><code>PS C:\&gt; Test-DbaKerberos -SqlInstance sql2016 | Where-Object Category -eq &quot;SPN&quot;
580+
</code></pre>
581+
<p>Returns only the SPN-related checks for the specified instance.<br></p>
582+
<h5 id="example-7">Example: 7</h5>
583+
<pre><code>PS C:\&gt; Test-DbaKerberos -SqlInstance sql2016 | Format-Table -AutoSize
584+
</code></pre>
585+
<p>Displays results in a formatted table for easier reading.<br></p>
543586
<h3 id="required-parameters">Required Parameters</h3>
544587
<h5 id="sqlinstance">-SqlInstance</h5>
545588
<p>The target SQL Server instance or instances to test Kerberos configuration.<br />
546589
Accepts SQL Server instance names and supports pipeline input for bulk testing.<br />
547-
The function will perform comprehensive Kerberos diagnostics for each specified instance. <br></p>
590+
All checks including SQL Server-specific checks will be performed. <br></p>
548591
<table>
549592
<thead>
550593
<tr>
@@ -574,7 +617,8 @@ <h5 id="sqlinstance">-SqlInstance</h5>
574617
<h5 id="computername">-ComputerName</h5>
575618
<p>Alternative parameter to specify target computers to test.<br />
576619
Use this when you want to test Kerberos configuration at the computer level rather than for specific SQL instances.<br />
577-
Accepts computer names, IP addresses, or fully qualified domain names. <br></p>
620+
Accepts computer names, IP addresses, or fully qualified domain names.<br />
621+
Note: SQL Server-specific checks will be skipped when using this parameter. <br></p>
578622
<table>
579623
<thead>
580624
<tr>
@@ -603,7 +647,7 @@ <h5 id="computername">-ComputerName</h5>
603647
</table>
604648
<h3 id="optional-parameters">Optional Parameters</h3>
605649
<h5 id="sqlcredential">-SqlCredential</h5>
606-
<p>Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).<br />
650+
<p>Login to the target SQL Server instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).<br />
607651
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.<br />
608652
For MFA support, please use Connect-DbaInstance.<br></p>
609653
<table>
@@ -633,8 +677,8 @@ <h5 id="sqlcredential">-SqlCredential</h5>
633677
</tbody>
634678
</table>
635679
<h5 id="credential">-Credential</h5>
636-
<p>Alternative credential for connecting to Active Directory.<br />
637-
Required for querying AD to verify SPN registrations and service account properties.<br></p>
680+
<p>Credential for remote WinRM connections and Active Directory queries.<br />
681+
Used for Invoke-Command calls to remote servers and for querying AD to verify SPN registrations and service account properties.<br></p>
638682
<table>
639683
<thead>
640684
<tr>
@@ -661,35 +705,6 @@ <h5 id="credential">-Credential</h5>
661705
</tr>
662706
</tbody>
663707
</table>
664-
<h5 id="detailed">-Detailed</h5>
665-
<p>Returns detailed diagnostic output including intermediate check results and verbose findings.<br />
666-
Use this switch when you need comprehensive troubleshooting information beyond pass/fail status.<br></p>
667-
<table>
668-
<thead>
669-
<tr>
670-
<th></th>
671-
<th></th>
672-
</tr>
673-
</thead>
674-
<tbody>
675-
<tr>
676-
<td>Alias</td>
677-
<td></td>
678-
</tr>
679-
<tr>
680-
<td>Required</td>
681-
<td>False</td>
682-
</tr>
683-
<tr>
684-
<td>Pipeline</td>
685-
<td>false</td>
686-
</tr>
687-
<tr>
688-
<td>Default Value</td>
689-
<td>False</td>
690-
</tr>
691-
</tbody>
692-
</table>
693708
<h5 id="enableexception">-EnableException</h5>
694709
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
695710
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />

‎assets/dbatools-index.json‎

1.65 MB
Binary file not shown.

‎assets/external.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"version": "2.7.18",
2+
"version": "2.7.21",
33
"external_links": [
44
{
55
"name": "offline installs of dbatools",

0 commit comments

Comments
 (0)