Skip to content

Commit

Permalink
refreshing docs pages
Browse files Browse the repository at this point in the history
  • Loading branch information
@niphlod @github-actions
niphlod authored and github-actions[bot] committed Jun 3, 2024
1 parent 5be9013 commit fb3d7cd
Show file tree
Hide file tree
Showing 692 changed files with 6,346 additions and 6,247 deletions.
43 changes: 23 additions & 20 deletions Add-DbaAgDatabase.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -517,13 +517,15 @@ <h2 id="description">Description</h2>
<li>Step 5: Wait for the database to finish joining the Availability Group on the secondary replicas.</li>
</ul>
<p>Use Test-DbaAvailabilityGroup with -AddDatabase to test if all prerequisites are met.</p>
<p>If you have special requirements for the setup for the database at the replicas,
perform the backup and restore part with Backup-DbaDatabase and Restore-DbaDatabase in advance.
<p>If you have special requirements for the setup for the database at the replicas,<br />
perform the backup and restore part with Backup-DbaDatabase and Restore-DbaDatabase in advance.<br />
Please make sure that the last log backup has been restored before running Add-DbaAgDatabase.</p>
<h2 id="syntax">Syntax</h2>
<pre><code>Add-DbaAgDatabase
[-SqlInstance] &lt;DbaInstanceParameter&gt;
[-SqlCredential &lt;PSCredential&gt;] -AvailabilityGroup &lt;String&gt; -Database &lt;String[]&gt;
[-SqlCredential &lt;PSCredential&gt;]
-AvailabilityGroup &lt;String&gt;
-Database &lt;String[]&gt;
[-Secondary &lt;DbaInstanceParameter[]&gt;]
[-SecondarySqlCredential &lt;PSCredential&gt;]
[-SeedingMode &lt;String&gt;]
Expand All @@ -538,7 +540,8 @@ <h2 id="syntax">Syntax</h2>
Add-DbaAgDatabase
[-AvailabilityGroup] &lt;String&gt;
[-Secondary &lt;DbaInstanceParameter[]&gt;]
[-SecondarySqlCredential &lt;PSCredential&gt;] -InputObject &lt;Database[]&gt;
[-SecondarySqlCredential &lt;PSCredential&gt;]
-InputObject &lt;Database[]&gt;
[-SeedingMode &lt;String&gt;]
[-SharedPath &lt;String&gt;]
[-UseLastBackup]
Expand Down Expand Up @@ -586,7 +589,7 @@ <h5 id="example-5">Example: 5</h5>
<p>Adds db1 to ag1 on sql2017a and sql2017b. Uses compression and three files while taking the backups.<br></p>
<h3 id="required-parameters">Required Parameters</h3>
<h5 id="sqlinstance">-SqlInstance</h5>
<p>The primary replica of the Availability Group. Server version must be SQL Server version 2012 or higher.<br></p>
<p>The primary replica of the Availability Group. Server version must be SQL Server version 2012 or higher. <br></p>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -614,7 +617,7 @@ <h5 id="sqlinstance">-SqlInstance</h5>
</tbody>
</table>
<h5 id="availabilitygroup">-AvailabilityGroup</h5>
<p>The name of the Availability Group where the databases will be added.<br></p>
<p>The name of the Availability Group where the databases will be added. <br></p>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -642,7 +645,7 @@ <h5 id="availabilitygroup">-AvailabilityGroup</h5>
</tbody>
</table>
<h5 id="database">-Database</h5>
<p>The database(s) to add.<br></p>
<p>The database(s) to add. <br></p>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -670,7 +673,7 @@ <h5 id="database">-Database</h5>
</tbody>
</table>
<h5 id="inputobject">-InputObject</h5>
<p>Enables piping from Get-DbaDatabase, Get-DbaDbSharePoint and more.<br></p>
<p>Enables piping from Get-DbaDatabase, Get-DbaDbSharePoint and more. <br></p>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -699,8 +702,8 @@ <h5 id="inputobject">-InputObject</h5>
</table>
<h3 id="optional-parameters">Optional Parameters</h3>
<h5 id="sqlcredential">-SqlCredential</h5>
<p>Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
<p>Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).<br />
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.<br />
For MFA support, please use Connect-DbaInstance.<br></p>
<table>
<thead>
Expand Down Expand Up @@ -729,7 +732,7 @@ <h5 id="sqlcredential">-SqlCredential</h5>
</tbody>
</table>
<h5 id="secondary">-Secondary</h5>
<p>Not required - the command will figure this out. But use this parameter if secondary replicas listen on a non default port.
<p>Not required - the command will figure this out. But use this parameter if secondary replicas listen on a non default port.<br />
This parameter can be used to only add the databases on specific secondary replicas.<br></p>
<table>
<thead>
Expand Down Expand Up @@ -758,8 +761,8 @@ <h5 id="secondary">-Secondary</h5>
</tbody>
</table>
<h5 id="secondarysqlcredential">-SecondarySqlCredential</h5>
<p>Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
<p>Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).<br />
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.<br />
For MFA support, please use Connect-DbaInstance.<br></p>
<table>
<thead>
Expand Down Expand Up @@ -788,9 +791,9 @@ <h5 id="secondarysqlcredential">-SecondarySqlCredential</h5>
</tbody>
</table>
<h5 id="seedingmode">-SeedingMode</h5>
<p>Specifies how the secondary replica will be initially seeded.
Automatic enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica.
Manual uses full and log backup to initially transfer the data to the secondary replica. The command skips this if the database is found in restoring state at the secondary replica.
<p>Specifies how the secondary replica will be initially seeded.<br />
Automatic enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica.<br />
Manual uses full and log backup to initially transfer the data to the secondary replica. The command skips this if the database is found in restoring state at the secondary replica.<br />
If not specified, the setting from the availability group replica will be used. Otherwise the setting will be updated.<br></p>
<table>
<thead>
Expand Down Expand Up @@ -823,8 +826,8 @@ <h5 id="seedingmode">-SeedingMode</h5>
</tbody>
</table>
<h5 id="sharedpath">-SharedPath</h5>
<p>The network share where the backups will be backed up and restored from.
Each SQL Server service account must have access to this share.
<p>The network share where the backups will be backed up and restored from.<br />
Each SQL Server service account must have access to this share.<br />
NOTE: If a backup / restore is performed, the backups will be left in tact on the network share.<br></p>
<table>
<thead>
Expand Down Expand Up @@ -909,8 +912,8 @@ <h5 id="advancedbackupparams">-AdvancedBackupParams</h5>
</tbody>
</table>
<h5 id="enableexception">-EnableException</h5>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<table>
<thead>
Expand Down
6 changes: 3 additions & 3 deletions Add-DbaAgListener.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -608,7 +608,7 @@ <h5 id="availabilitygroup">-AvailabilityGroup</h5>
</tbody>
</table>
<h5 id="name">-Name</h5>
<p>The name of the listener. If one is not specified, the Availability Group name will be used.
<p>The name of the listener. If one is not specified, the Availability Group name will be used.<br />
Note that Name cannot be used with Multiple Ags.<br></p>
<table>
<thead>
Expand Down Expand Up @@ -833,8 +833,8 @@ <h5 id="inputobject">-InputObject</h5>
</tbody>
</table>
<h5 id="enableexception">-EnableException</h5>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<table>
<thead>
Expand Down
52 changes: 26 additions & 26 deletions Add-DbaAgReplica.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -533,7 +533,7 @@ <h5 id="example-3">Example: 3</h5>
<p>Adds sql2017b to the SharePoint availability group on sql2017a with a custom endpoint URL.<br></p>
<h3 id="required-parameters">Required Parameters</h3>
<h5 id="sqlinstance">-SqlInstance</h5>
<p>The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher.<br></p>
<p>The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher. <br></p>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -561,7 +561,7 @@ <h5 id="sqlinstance">-SqlInstance</h5>
</tbody>
</table>
<h5 id="inputobject">-InputObject</h5>
<p>Enables piping from Get-DbaAvailabilityGroup.<br></p>
<p>Enables piping from Get-DbaAvailabilityGroup. <br></p>
<table>
<thead>
<tr>
Expand Down Expand Up @@ -590,8 +590,8 @@ <h5 id="inputobject">-InputObject</h5>
</table>
<h3 id="optional-parameters">Optional Parameters</h3>
<h5 id="sqlcredential">-SqlCredential</h5>
<p>Login to the target instances using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
<p>Login to the target instances using alternative credentials. Accepts PowerShell credentials (Get-Credential).<br />
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.<br />
For MFA support, please use Connect-DbaInstance.<br></p>
<table>
<thead>
Expand Down Expand Up @@ -620,7 +620,7 @@ <h5 id="sqlcredential">-SqlCredential</h5>
</tbody>
</table>
<h5 id="name">-Name</h5>
<p>The name of the replica. Defaults to the SQL Server instance name.
<p>The name of the replica. Defaults to the SQL Server instance name.<br />
This parameter is only supported if the replica is added to just one instance.<br></p>
<table>
<thead>
Expand Down Expand Up @@ -649,10 +649,10 @@ <h5 id="name">-Name</h5>
</tbody>
</table>
<h5 id="clustertype">-ClusterType</h5>
<p>Cluster type of the Availability Group. Only supported in SQL Server 2017 and above.
Options include: Wsfc, External or None.
Defaults to Wsfc (Windows Server Failover Cluster).
The default can be changed with:
<p>Cluster type of the Availability Group. Only supported in SQL Server 2017 and above.<br />
Options include: Wsfc, External or None.<br />
Defaults to Wsfc (Windows Server Failover Cluster).<br />
The default can be changed with:<br />
Set-DbatoolsConfig -FullName 'AvailabilityGroups.Default.ClusterType' -Value '...' -Passthru | Register-DbatoolsConfig<br></p>
<table>
<thead>
Expand Down Expand Up @@ -809,10 +809,10 @@ <h5 id="connectionmodeinprimaryrole">-ConnectionModeInPrimaryRole</h5>
</tbody>
</table>
<h5 id="connectionmodeinsecondaryrole">-ConnectionModeInSecondaryRole</h5>
<p>Specifies the connection modes of an Availability Replica in secondary role.
Options include: AllowNoConnections, AllowReadIntentConnectionsOnly, AllowAllConnections
Defaults to AllowNoConnections.
The default can be changed with:
<p>Specifies the connection modes of an Availability Replica in secondary role.<br />
Options include: AllowNoConnections, AllowReadIntentConnectionsOnly, AllowAllConnections<br />
Defaults to AllowNoConnections.<br />
The default can be changed with:<br />
Set-DbatoolsConfig -FullName 'AvailabilityGroups.Default.ConnectionModeInSecondaryRole' -Value '...' -Passthru | Register-DbatoolsConfig<br></p>
<table>
<thead>
Expand Down Expand Up @@ -845,8 +845,8 @@ <h5 id="connectionmodeinsecondaryrole">-ConnectionModeInSecondaryRole</h5>
</tbody>
</table>
<h5 id="seedingmode">-SeedingMode</h5>
<p>Specifies how the secondary replica will be initially seeded.
Automatic enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica.
<p>Specifies how the secondary replica will be initially seeded.<br />
Automatic enables direct seeding. This method will seed the secondary replica over the network. This method does not require you to backup and restore a copy of the primary database on the replica.<br />
Manual requires you to create a backup of the database on the primary replica and manually restore that backup on the secondary replica.<br></p>
<table>
<thead>
Expand Down Expand Up @@ -879,7 +879,7 @@ <h5 id="seedingmode">-SeedingMode</h5>
</tbody>
</table>
<h5 id="endpoint">-Endpoint</h5>
<p>By default, this command will attempt to find a DatabaseMirror endpoint. If one does not exist, it will create it.
<p>By default, this command will attempt to find a DatabaseMirror endpoint. If one does not exist, it will create it.<br />
If an endpoint must be created, the name &quot;hadr_endpoint&quot; will be used. If an alternative is preferred, use Endpoint.<br></p>
<table>
<thead>
Expand Down Expand Up @@ -908,10 +908,10 @@ <h5 id="endpoint">-Endpoint</h5>
</tbody>
</table>
<h5 id="endpointurl">-EndpointUrl</h5>
<p>By default, the property Fqdn of Get-DbaEndpoint is used as EndpointUrl.
Use EndpointUrl if a different URL is required due to special network configurations.
EndpointUrl has to be an array of strings in format 'TCP://system-address:port', one entry for every instance.
See details at: <a href="https://docs.microsoft.com/en-us/sql/database-engine/availability-groups/windows/specify-endpoint-url-adding-or-modifying-availability-replica">https://docs.microsoft.com/en-us/sql/database-engine/availability-groups/windows/specify-endpoint-url-adding-or-modifying-availability-replica</a>
<p>By default, the property Fqdn of Get-DbaEndpoint is used as EndpointUrl.<br />
Use EndpointUrl if a different URL is required due to special network configurations.<br />
EndpointUrl has to be an array of strings in format 'TCP://system-address:port', one entry for every instance.<br />
See details at: <a href="https://docs.microsoft.com/en-us/sql/database-engine/availability-groups/windows/specify-endpoint-url-adding-or-modifying-availability-replica">https://docs.microsoft.com/en-us/sql/database-engine/availability-groups/windows/specify-endpoint-url-adding-or-modifying-availability-replica</a><br />
If an endpoint must be created, EndpointUrl will be used for configuration, if system-address is an ipv4 address.<br></p>
<table>
<thead>
Expand Down Expand Up @@ -968,7 +968,7 @@ <h5 id="passthru">-Passthru</h5>
</tbody>
</table>
<h5 id="readonlyroutinglist">-ReadOnlyRoutingList</h5>
<p>Sets the read only routing ordered list of replica server names to use when redirecting read-only connections through this availability replica.
<p>Sets the read only routing ordered list of replica server names to use when redirecting read-only connections through this availability replica.<br />
This parameter is only supported if the replica is added to just one instance.<br></p>
<table>
<thead>
Expand Down Expand Up @@ -997,7 +997,7 @@ <h5 id="readonlyroutinglist">-ReadOnlyRoutingList</h5>
</tbody>
</table>
<h5 id="readonlyroutingconnectionurl">-ReadonlyRoutingConnectionUrl</h5>
<p>Sets the read only routing connection url for the availability replica.
<p>Sets the read only routing connection url for the availability replica.<br />
This parameter is only supported if the replica is added to just one instance.<br></p>
<table>
<thead>
Expand Down Expand Up @@ -1026,7 +1026,7 @@ <h5 id="readonlyroutingconnectionurl">-ReadonlyRoutingConnectionUrl</h5>
</tbody>
</table>
<h5 id="certificate">-Certificate</h5>
<p>Specifies that the endpoint is to authenticate the connection using the certificate specified by certificate_name to establish identity for authorization.
<p>Specifies that the endpoint is to authenticate the connection using the certificate specified by certificate_name to establish identity for authorization.<br />
The far endpoint must have a certificate with the public key matching the private key of the specified certificate.<br></p>
<table>
<thead>
Expand Down Expand Up @@ -1055,7 +1055,7 @@ <h5 id="certificate">-Certificate</h5>
</tbody>
</table>
<h5 id="configurexesession">-ConfigureXESession</h5>
<p>Configure the AlwaysOn_health extended events session to start automatically as the SSMS wizard would do.
<p>Configure the AlwaysOn_health extended events session to start automatically as the SSMS wizard would do.<br />
<a href="https://docs.microsoft.com/en-us/sql/database-engine/availability-groups/windows/always-on-extended-events#BKMK_alwayson_health">https://docs.microsoft.com/en-us/sql/database-engine/availability-groups/windows/always-on-extended-events#BKMK_alwayson_health</a><br></p>
<table>
<thead>
Expand Down Expand Up @@ -1112,8 +1112,8 @@ <h5 id="sessiontimeout">-SessionTimeout</h5>
</tbody>
</table>
<h5 id="enableexception">-EnableException</h5>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<table>
<thead>
Expand Down
28 changes: 14 additions & 14 deletions Add-DbaComputerCertificate.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -721,18 +721,18 @@ <h5 id="folder">-Folder</h5>
</tbody>
</table>
<h5 id="flag">-Flag</h5>
<p>Defines where and how to import the private key of an X.509 certificate.
Defaults to: Exportable, PersistKeySet
EphemeralKeySet
The key associated with a PFX file is created in memory and not persisted on disk when importing a certificate.
Exportable
Imported keys are marked as exportable.
NonExportable
Expliictly mark keys as nonexportable.
PersistKeySet
The key associated with a PFX file is persisted when importing a certificate.
UserProtected
Notify the user through a dialog box or other method that the key is accessed. The Cryptographic Service Provider (CSP) in use defines the precise behavior. NOTE: This can only be used when you
<p>Defines where and how to import the private key of an X.509 certificate.<br />
Defaults to: Exportable, PersistKeySet<br />
EphemeralKeySet<br />
The key associated with a PFX file is created in memory and not persisted on disk when importing a certificate.<br />
Exportable<br />
Imported keys are marked as exportable.<br />
NonExportable<br />
Expliictly mark keys as nonexportable.<br />
PersistKeySet<br />
The key associated with a PFX file is persisted when importing a certificate.<br />
UserProtected<br />
Notify the user through a dialog box or other method that the key is accessed. The Cryptographic Service Provider (CSP) in use defines the precise behavior. NOTE: This can only be used when you<br />
add a certificate to localhost, as it causes a prompt to appear.<br></p>
<table>
<thead>
Expand Down Expand Up @@ -765,8 +765,8 @@ <h5 id="flag">-Flag</h5>
</tbody>
</table>
<h5 id="enableexception">-EnableException</h5>
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.
<p>By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.<br />
This avoids overwhelming you with &quot;sea of red&quot; exceptions, but is inconvenient because it basically disables advanced scripting.<br />
Using this switch turns this &quot;nice by default&quot; feature off and enables you to catch exceptions with your own try/catch.<br></p>
<table>
<thead>
Expand Down
Loading

0 comments on commit fb3d7cd

Please sign in to comment.