Skip to content

Commit a1c6b4b

Browse files
Enhance and clarify documentation (#9803)
1 parent 0065ab6 commit a1c6b4b

File tree

657 files changed

+2554
-2176
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

657 files changed

+2554
-2176
lines changed

public/Add-DbaAgDatabase.ps1

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
function Add-DbaAgDatabase {
22
<#
33
.SYNOPSIS
4-
Adds database(s) to an Availability Group on a SQL Server instance.
4+
Adds databases to an Availability Group with automated backup, restore, and synchronization handling.
55
66
.DESCRIPTION
7-
Adds database(s) to an Availability Group on a SQL Server instance.
7+
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.
88
9-
After checking for prerequisites, the commands runs these five steps for every database:
9+
The command executes a comprehensive five-step process for each database:
1010
* Step 1: Setting seeding mode if needed.
1111
- If -SeedingMode is used and the current seeding mode of the replica is not in the desired mode, the seeding mode of the replica is changed.
1212
- The seeding mode will not be changed back but stay in this mode.
@@ -21,11 +21,9 @@ function Add-DbaAgDatabase {
2121
- This step is skipped for those replicas, where the database is already joined to the Availability Group.
2222
* Step 5: Wait for the database to finish joining the Availability Group on the secondary replicas.
2323
24-
Use Test-DbaAvailabilityGroup with -AddDatabase to test if all prerequisites are met.
24+
Use Test-DbaAvailabilityGroup with -AddDatabase to test if all prerequisites are met before running this command.
2525
26-
If you have special requirements for the setup for the database at the replicas,
27-
perform the backup and restore part with Backup-DbaDatabase and Restore-DbaDatabase in advance.
28-
Please make sure that the last log backup has been restored before running Add-DbaAgDatabase.
26+
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.
2927
3028
.PARAMETER SqlInstance
3129
The primary replica of the Availability Group. Server version must be SQL Server version 2012 or higher.
@@ -562,4 +560,4 @@ function Add-DbaAgDatabase {
562560
}
563561
Write-Progress @progress -Completed
564562
}
565-
}
563+
}

public/Add-DbaAgListener.ps1

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,14 @@
22
function Add-DbaAgListener {
33
<#
44
.SYNOPSIS
5-
Adds a listener to an availability group on a SQL Server instance.
5+
Creates a network listener endpoint for an Availability Group to provide client connectivity
66
77
.DESCRIPTION
8-
Adds a listener to an availability group on a SQL Server instance.
8+
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.
9+
10+
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.
11+
12+
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.
913
1014
.PARAMETER SqlInstance
1115
The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher.

public/Add-DbaComputerCertificate.ps1

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
function Add-DbaComputerCertificate {
22
<#
33
.SYNOPSIS
4-
Adds a computer certificate - useful for older systems.
4+
Imports X.509 certificates into the Windows certificate store on local or remote computers.
55
66
.DESCRIPTION
7-
Adds a computer certificate from a local or remote computer.
7+
Imports X.509 certificates (including password-protected .pfx files with private keys) into the specified Windows certificate store on one or more computers. This function is essential for SQL Server TLS/SSL encryption setup, Availability Group certificate requirements, and Service Broker security configurations.
8+
9+
The function handles both certificate files from disk and certificate objects from the pipeline, supports remote installation via PowerShell remoting, and allows you to control import behavior through various flags like exportable/non-exportable private keys. By default, certificates are installed to the LocalMachine\My (Personal) store with exportable and persistent private keys, which is the standard location for SQL Server service certificates.
810
911
.PARAMETER ComputerName
1012
The target SQL Server instance or instances. Defaults to localhost.

public/Add-DbaDbRoleMember.ps1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
function Add-DbaDbRoleMember {
22
<#
33
.SYNOPSIS
4-
Adds a Database User to a database role for each instance(s) of SQL Server.
4+
Adds database users or roles as members to database roles across SQL Server instances
55
66
.DESCRIPTION
7-
The Add-DbaDbRoleMember adds users in a database to a database role or roles for each instance(s) of SQL Server.
7+
Manages database security by adding users or roles as members to database roles, automating what would otherwise require manual T-SQL commands or SQL Server Management Studio clicks. This function handles membership validation to ensure the user or role exists in the database before attempting to add them, and checks existing membership to prevent duplicate assignments. You can add multiple users to multiple roles across multiple databases and instances in a single operation, making it ideal for bulk security configuration or automated permission management workflows.
88
99
.PARAMETER SqlInstance
1010
The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.

public/Add-DbaExtendedProperty.ps1

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
function Add-DbaExtendedProperty {
22
<#
33
.SYNOPSIS
4-
Adds an extended property
4+
Adds extended properties to SQL Server objects for metadata storage and documentation
55
66
.DESCRIPTION
7-
Adds an extended property
7+
Creates custom metadata properties on SQL Server objects to store documentation, version information, business context, or compliance tags. Extended properties are stored in the database system catalogs and don't affect object performance but provide valuable context for DBAs managing complex environments.
88
9-
This command works out of the box with databases but you can add extended properties from several different types of objects, including:
9+
This command accepts piped input from any dbatools Get-Dba* command, making it easy to bulk-apply properties across multiple objects. You can add extended properties to databases directly or target specific object types, including:
1010
1111
Aggregate
1212
Assembly

public/Add-DbaPfDataCollectorCounter.ps1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
function Add-DbaPfDataCollectorCounter {
22
<#
33
.SYNOPSIS
4-
Adds a Performance Data Collector Counter.
4+
Adds performance counters to existing Windows Performance Monitor Data Collector Sets for SQL Server monitoring.
55
66
.DESCRIPTION
7-
Adds a Performance Data Collector Counter.
7+
Adds specific performance counters to existing Data Collector Sets within Windows Performance Monitor. This allows DBAs to customize their performance monitoring by adding SQL Server-specific counters like disk queue length, processor time, or SQL Server object counters to existing collection sets. The function modifies the Data Collector Set configuration and immediately applies the changes, so you can start collecting the additional performance metrics without recreating your monitoring setup.
88
99
.PARAMETER ComputerName
1010
The target computer. Defaults to localhost.

public/Add-DbaRegServer.ps1

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
function Add-DbaRegServer {
22
<#
33
.SYNOPSIS
4-
Adds registered servers to SQL Server Central Management Server (CMS) or Local Server Groups
4+
Registers SQL Server instances to Central Management Server or Local Server Groups in SSMS
55
66
.DESCRIPTION
7-
Adds registered servers to SQL Server Central Management Server (CMS) or Local Server Groups. If you need more flexibility, look into Import-DbaRegServer which
8-
accepts multiple kinds of input and allows you to add reg servers from different CMSes.
7+
Registers SQL Server instances as managed servers within SSMS, either to a Central Management Server (CMS) for enterprise-wide management or to Local Server Groups for personal organization. This allows DBAs to centrally organize and quickly connect to multiple SQL Server instances from SSMS without manually typing connection details each time. The function automatically creates server groups if they don't exist and supports various authentication methods including SQL Server, Windows, and Azure Active Directory. For importing existing registered servers from other sources, use Import-DbaRegServer instead.
98
109
.PARAMETER SqlInstance
1110
The target SQL Server instance if a CMS is used

public/Add-DbaRegServerGroup.ps1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
function Add-DbaRegServerGroup {
22
<#
33
.SYNOPSIS
4-
Adds registered server groups to SQL Server Central Management Server (CMS)
4+
Creates organizational server groups within SQL Server Central Management Server (CMS)
55
66
.DESCRIPTION
7-
Adds registered server groups to SQL Server Central Management Server (CMS). If you need more flexibility, look into Import-DbaRegServer which accepts multiple kinds of input and allows you to add reg servers and groups from different CMS.
7+
Creates new server groups in SQL Server Central Management Server to organize registered servers into logical hierarchies. This allows DBAs to group servers by environment, application, location, or any other classification system for easier management at scale. Supports nested group structures using backslash notation (Group\SubGroup) and automatically creates parent groups if they don't exist. If you need to import existing groups and servers from other sources, use Import-DbaRegServer instead.
88
99
.PARAMETER SqlInstance
1010
The target SQL Server instance

public/Add-DbaReplArticle.ps1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
function Add-DbaReplArticle {
22
<#
33
.SYNOPSIS
4-
Add an article configuration to a publication in a database on the SQL Server instance(s).
4+
Adds a table or other database object as an article to an existing replication publication.
55
66
.DESCRIPTION
7-
Add an article configuration to a publication in a database on the SQL Server instance(s).
7+
Adds a database object (typically a table) as an article to an existing SQL Server replication publication. Articles define which tables and data get replicated to subscribers. This function supports both transactional and merge replication publications, allowing you to expand replication topology without using SQL Server Management Studio. You can apply horizontal filters to replicate only specific rows, and customize schema options like indexes and statistics that get created on subscriber databases.
88
99
.PARAMETER SqlInstance
1010
The SQL Server instance(s) for the publication.

public/Add-DbaServerRoleMember.ps1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
function Add-DbaServerRoleMember {
22
<#
33
.SYNOPSIS
4-
Adds a login to a server-level role(s) for each instance(s) of SQL Server.
4+
Adds logins or server roles to server-level roles for SQL Server security administration.
55
66
.DESCRIPTION
7-
Adds a login to a server-level role(s) for each instance(s) of SQL Server.
7+
Grants server-level role membership to SQL logins or nests server roles within other server roles. Use this command when setting up security permissions, implementing role-based access control, or managing server-level privileges across multiple SQL Server instances. Supports both built-in roles (sysadmin, dbcreator, etc.) and custom server roles, so you don't have to manually assign permissions through SSMS or T-SQL scripts.
88
99
.PARAMETER SqlInstance
1010
The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.

0 commit comments

Comments
 (0)