You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Want to see the Bill Of Health for this command? Check out <ahref="https://dataplat.github.io/boh#Add-DbaAgDatabase">Add-DbaAgDatabase</a>.</p>
487
487
<h2id="synopsis">Synopsis</h2>
488
-
<p>Adds database(s) to an Availability Group on a SQL Server instance.</p>
488
+
<p>Adds databases to an Availability Group with automated backup, restore, and synchronization handling.</p>
489
489
<h2id="description">Description</h2>
490
-
<p>Adds database(s) to an Availability Group on a SQL Server instance.</p>
491
-
<p>After checking for prerequisites, the commands runs these five steps for every database:</p>
490
+
<p>Adds databases to an Availability Group and handles the complete process from backup through synchronization. This command eliminates the manual steps typically required when expanding Availability Groups with new databases, automatically managing seeding modes, backup/restore operations, and replica synchronization.</p>
491
+
<p>The command executes a comprehensive five-step process for each database:</p>
<li>Step 5: Wait for the database to finish joining the Availability Group on the secondary replicas.</li>
518
518
</ul>
519
-
<p>Use Test-DbaAvailabilityGroup with -AddDatabase to test if all prerequisites are met.</p>
520
-
<p>If you have special requirements for the setup for the database at the replicas,<br/>
521
-
perform the backup and restore part with Backup-DbaDatabase and Restore-DbaDatabase in advance.<br/>
522
-
Please make sure that the last log backup has been restored before running Add-DbaAgDatabase.</p>
519
+
<p>Use Test-DbaAvailabilityGroup with -AddDatabase to test if all prerequisites are met before running this command.</p>
520
+
<p>For custom backup and restore requirements, perform those operations with Backup-DbaDatabase and Restore-DbaDatabase in advance, ensuring the last log backup has been restored before running Add-DbaAgDatabase.</p>
<p>Not required - the command will figure this out. But use this parameter if secondary replicas listen on a non default port.<br/>
736
-
This parameter can be used to only add the databases on specific secondary replicas.<br></p>
736
+
<p>Specifies secondary replica instances to target for database addition. Auto-discovered if not specified.<br/>
737
+
Use this when replicas use non-standard ports or when you want to limit the operation to specific secondary replicas rather than all replicas in the AG.<br></p>
<p>Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).<br/>
765
-
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.<br/>
766
-
For MFA support, please use Connect-DbaInstance.<br></p>
765
+
<p>Authentication credentials for connecting to secondary replica instances when they require different credentials than the primary.<br/>
766
+
Use this when secondary replicas are in different domains, use SQL authentication, or require service accounts with specific permissions for backup/restore operations.<br></p>
<p>Specifies how the secondary replica will be initially seeded.<br/>
795
-
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/>
796
-
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/>
797
-
If not specified, the setting from the availability group replica will be used. Otherwise the setting will be updated.<br></p>
794
+
<p>Controls how database data is transferred to secondary replicas during AG addition. Valid values are 'Automatic' or 'Manual'.<br/>
795
+
Automatic seeding transfers data directly over the network without requiring backup/restore operations, but needs sufficient network bandwidth and proper endpoint configuration.<br/>
796
+
Manual seeding uses traditional backup/restore through shared storage, giving you more control over timing and storage location but requiring accessible file shares.<br></p>
<p>The network share where the backups will be backed up and restored from.<br/>
830
-
Each SQL Server service account must have access to this share.<br/>
831
-
NOTE: If a backup / restore is performed, the backups will be left in tact on the network share.<br></p>
828
+
<p>Specifies the UNC network path where backups are stored during manual seeding operations. Required when using Manual seeding mode.<br/>
829
+
All SQL Server service accounts from primary and secondary replicas must have read/write access to this location. Backup files remain on the share after completion for potential reuse or cleanup.<br></p>
<p>Use the last full and log backup of the database. A log backup must be the last backup.<br></p>
857
+
<p>Uses existing backup history instead of creating new backups for manual seeding. The most recent log backup must be newer than the most recent full backup.<br/>
858
+
Use this when you have recent backups available and want to avoid taking additional backups, reducing backup storage requirements and time.<br></p>
<p>Provide additional parameters to the backup command as a hashtable.<br></p>
886
+
<pCompressBackup="$true;" FileCount="4">Passes additional parameters to Backup-DbaDatabase as a hashtable when creating backups during manual seeding.<br/>
887
+
Use this to control backup compression, file count, or other backup-specific settings like @ for faster backup operations.<br></p>
Want to see the Bill Of Health for this command? Check out <ahref="https://dataplat.github.io/boh#Add-DbaAgListener">Add-DbaAgListener</a>.</p>
487
487
<h2id="synopsis">Synopsis</h2>
488
-
<p>Adds a listener to an availability group on a SQL Server instance.</p>
488
+
<p>Creates a network listener endpoint for an Availability Group to provide client connectivity</p>
489
489
<h2id="description">Description</h2>
490
-
<p>Adds a listener to an availability group on a SQL Server instance.</p>
490
+
<p>Creates a network listener endpoint that provides a virtual network name and IP address for clients to connect to an Availability Group. The listener automatically routes client connections to the current primary replica, eliminating the need for applications to track which server is currently hosting the primary database.</p>
491
+
<p>This function supports both single-subnet and multi-subnet Availability Group configurations. You can specify static IP addresses for each subnet or use DHCP for automatic IP assignment. For multi-subnet deployments, specify multiple IP addresses and subnet masks to handle failover across geographically dispersed replicas.</p>
492
+
<p>Use this when setting up new Availability Groups or when adding listeners to existing groups that don't have client connectivity configured yet. Without a listener, applications must connect directly to replica server names, which breaks during failover scenarios.</p>
<p>The Availability Group to which a listener will be bestowed upon.<br></p>
585
+
<p>Specifies the name of the Availability Group that will receive the listener. Use this when connecting directly to a SQL Server instance rather than piping from Get-DbaAvailabilityGroup.<br/>
586
+
Required when using the SqlInstance parameter to identify which AG on the server needs client connectivity.<br></p>
<p>The name of the listener. If one is not specified, the Availability Group name will be used.<br/>
612
-
Note that Name cannot be used with Multiple Ags.<br></p>
614
+
<p>Specifies a custom network name for the listener that clients will use to connect. Defaults to the Availability Group name if not specified.<br/>
615
+
Use this when you need a different DNS name than your AG name, such as for application connection strings that can't be changed.<br/>
616
+
Cannot be used when processing multiple Availability Groups in a single operation.<br></p>
613
617
<table>
614
618
<thead>
615
619
<tr>
@@ -637,7 +641,9 @@ <h5 id="name">-Name</h5>
637
641
</tbody>
638
642
</table>
639
643
<h5id="ipaddress">-IPAddress</h5>
640
-
<p>Sets the IP address(es) of the availability group listener.<br></p>
644
+
<p>Specifies one or more static IP addresses for the listener to use across different subnets. Each IP should correspond to a subnet where AG replicas are located.<br/>
645
+
Use this for multi-subnet deployments or when DHCP is not available in your network environment.<br/>
646
+
Cannot be combined with the Dhcp parameter.<br></p>
<p>Sets the Subnet IP address(es) of the availability group listener.<br></p>
674
+
<p>Specifies the network subnet addresses where the listener IPs will be configured. Auto-calculated from IPAddress and SubnetMask if not provided.<br/>
675
+
Use this when you need explicit control over subnet configuration or when auto-calculation produces incorrect results.<br/>
676
+
Must match the number of IP addresses specified, or provide a single subnet to apply to all IPs.<br></p>
<p>Sets the port number used to communicate with the availability group. Defaults to 1433.<br></p>
734
+
<p>Specifies the TCP port number that clients will use to connect to the listener. Defaults to 1433.<br/>
735
+
Change this when your environment requires non-standard SQL Server ports due to security policies or port conflicts with other services.<br></p>
725
736
<table>
726
737
<thead>
727
738
<tr>
@@ -749,7 +760,8 @@ <h5 id="port">-Port</h5>
749
760
</tbody>
750
761
</table>
751
762
<h5id="dhcp">-Dhcp</h5>
752
-
<p>Indicates whether the listener uses DHCP.<br></p>
763
+
<p>Configures the listener to obtain IP addresses automatically from DHCP rather than using static IPs. Simplifies network configuration when DHCP reservations are managed centrally.<br/>
764
+
Cannot be used with IPAddress parameter and requires single-subnet AG configurations only.<br></p>
753
765
<table>
754
766
<thead>
755
767
<tr>
@@ -777,7 +789,8 @@ <h5 id="dhcp">-Dhcp</h5>
777
789
</tbody>
778
790
</table>
779
791
<h5id="passthru">-Passthru</h5>
780
-
<p>Don't create the listener, just pass thru an object that can be further customized before creation.<br></p>
792
+
<p>Returns the listener object without creating it on the server, allowing for additional configuration before calling Create().<br/>
793
+
Use this when you need to set advanced properties not exposed by this function's parameters before committing the listener to SQL Server.<br></p>
<p>Enables piping from Get-DbaAvailabilityGroup<br></p>
821
+
<p>Accepts Availability Group objects from Get-DbaAvailabilityGroup through the pipeline, eliminating the need to specify SqlInstance and AvailabilityGroup parameters.<br/>
822
+
Use this approach when working with multiple AGs or when you need to filter AGs before creating listeners.<br></p>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments