151 PowerShell commands across 17 categories — each with parameters, usage notes, and runnable examples.
Generated against a lab SQL Server instance seeded with the AdventureWorks sample database — read-only, no production or customer data. Each page below is the exact HTML output the corresponding command produces.
| Command | Description | Since |
|---|---|---|
Add-sqmDatabaseToAG | Adds one or more databases to an Always On availability group (AutoSeed). | v1.4.7.0 |
Compare-sqmAlwaysOnLogins | Compares the logins of all replicas in an AlwaysOn Availability Group. | v1.4.7.0 |
Compare-sqmAlwaysOnRoles | Compares server-role membership (sysadmin, dbcreator, ...) for every login across all replicas of an AlwaysOn Availability Group. | v1.9.0.0 |
Complete-sqmListenerMigration | Completes listener migration after cluster team recreates the listener resource. | v1.4.6.0 |
Export-sqmAlwaysOnConfiguration | Exports the complete AlwaysOn AG configuration for one or more SQL Server instances. | v1.4.3.0 |
Get-sqmAlwaysOnFailoverHistory | Retrieves AlwaysOn failover events from the Windows Event Log. | v1.4.7.0 |
Get-sqmAlwaysOnHealthReport | Creates a detailed health report for all Always On availability groups on an instance. | v1.4.7.0 |
Invoke-sqmAlwaysOnSetup | End-to-end CLI AlwaysOn setup: reads the WSFC, creates the Availability Group and synchronises logins. | v1.5.2.0 |
Invoke-sqmFailover | Performs a controlled AlwaysOn AG failover with pre- and post-checks. | v1.0.0.0 |
Invoke-sqmServiceBrokerAlwaysOn | Enables Service Broker on all nodes of an AlwaysOn Availability Group with automatic failover orchestration. | v1.5.2.0 |
Invoke-sqmSqlAlwaysOnAutoseeding | Enables Automatic Seeding on all replicas of an Always On Availability Group. | v1.0.0.0 |
Move-sqmAlwaysOnListener | Migrates an AG Listener from one Availability Group to another. | v1.4.7.0 |
New-sqmAlwaysOnRepairJob | Creates a SQL Server Agent job that runs Repair-Job.ps1 (AutoRepair). | v1.0.0.0 |
New-sqmAutoLoginSyncJob | Creates a SQL Agent job that runs Sync-Job.ps1 (AutoSync). | v1.4.7.0 |
New-sqmAvailabilityGroup | Creates an AlwaysOn Availability Group on an existing Windows Server Failover Cluster (WSFC). | v1.5.2.0 |
Prepare-sqmListenerForMigration | Prepares an AG listener for cluster-level migration without downtime. | v1.4.6.0 |
Remove-sqmDatabaseFromAG | Removes one or more databases from their Always On Availability Group. | v1.0.0.0 |
Repair-sqmAlwaysOnDatabases | Checks all AlwaysOn databases for problems and repairs them (Remove -> Cleanup -> Add). | v1.0.0.0 |
Sync-sqmAgNode | Synchronizes SQL Server objects from the primary replica to all secondary replicas of an Availability Group. | v1.0.0.0 |
Sync-sqmLoginsToAlwaysOn | Synchronizes logins from the primary replica to all secondary replicas in an AlwaysOn Availability Group. | v1.4.7.0 |
| Command | Description | Since |
|---|---|---|
Add-sqmDatabaseToDistributedAg | Adds a database to a Distributed AlwaysOn Availability Group. | v1.4.4.0 |
Get-sqmDistributedAgHealth | Creates a detailed health report for Distributed AlwaysOn Availability Groups. | v1.4.4.0 |
Invoke-sqmDistributedFailover | Initiates failover of a Distributed AlwaysOn AG. | v1.4.4.0 |
New-sqmDistributedAvailabilityGroup | Creates a new Distributed AlwaysOn Availability Group. | v1.4.5.0 |
Test-sqmDistributedAgReadiness | Tests Distributed AlwaysOn AG readiness for failover. | v1.4.4.0 |
| Command | Description | Since |
|---|---|---|
Enable-sqmServiceBroker | Enables Service Broker on a specified database and creates SSB endpoint. | v1.5.1.0 |
Get-sqmServiceBrokerHealth | Creates a health report for SQL Server Service Broker configuration and status. | v1.5.1.0 |
| Command | Description | Since |
|---|---|---|
Get-sqmServersFromOU | Retrieves all computer objects from a specific AD OU and outputs them as pipeline-friendly objects. | v1.7.3.0 |
Invoke-sqmLogShrink | Shrinks the transaction log file (LDF) of one or more databases. | v1.0.0.0 |
Invoke-sqmRestoreDatabase | Restores a database from a backup file, with support for single-server and AlwaysOn environments. | v1.0.0.0 |
Invoke-sqmRestoreTest | Performs an auditable restore test: restores a database under a test name and documents success, data volume, throughput and duration as TXT and HTML report. | v1.9.23.0 |
Invoke-sqmUserDatabaseBackup | Backs up user databases on a SQL Server instance. | v1.0.0.0 |
New-sqmBackupMaintenanceJob | Creates a SQL Agent job with two steps that implement the full dynamic backup maintenance workflow. | v1.0.0.0 |
New-sqmOlaSysDbBackupJob | Creates a SQL Agent job for the daily full backup of SQL Server system databases via Ola Hallengren's DatabaseBackup. | v1.0.0.0 |
New-sqmOlaUsrDbBackupJob | Creates SQL Agent jobs for FULL, DIFF, and/or LOG backups of user databases via Ola Hallengren's DatabaseBackup. | v1.0.0.0 |
New-sqmRestoreTestJob | Creates a scheduled SQL Server Agent job that runs Invoke-sqmRestoreTest and produces the recurring restore-test evidence. | v1.9.23.0 |
Register-sqmBackupExcludeTrigger | Registers or removes the DDL trigger that automatically keeps master.dbo.sqm_BackupExclude up to date on CREATE_DATABASE and DROP_DATABASE. | v1.7.2.0 |
Set-sqmBackupExcludePermission | Grants SELECT, INSERT, and UPDATE permissions on master.dbo.sqm_BackupExclude to a login. | v1.0.0.0 |
Show-sqmBackupExcludeForm | A WinForms dialog for managing the backup exclude table (master.dbo.sqm_BackupExclude). | v1.7.2.0 |
Sync-sqmBackupExcludeTable | Creates and synchronises the backup exclude table in the master database. | v1.0.0.0 |
Test-sqmBackupIntegrity | Verifies one or more backup files using RESTORE VERIFYONLY. | v1.0.0.0 |
| Command | Description | Since |
|---|---|---|
Enable-sqmMonitoringAccess | Sets up a monitoring account on all SQL Server instances of a computer. | v1.4.7.0 |
Find-sqmADUser | Searches Active Directory for user accounts matching a SamAccountName wildcard pattern. | v1.9.9.0 |
Get-sqmADAccountStatus | Checks the status of an Active Directory user account. | v1.0.0.0 |
Get-sqmADGroupMembers | Lists all members of an Active Directory group. | v1.4.2.0 |
Get-sqmADGroupMembersRecursive | Lists all members of an Active Directory group with controlled recursion depth. | v1.5.1.0 |
Get-sqmADMemberGroups | Finds all Active Directory groups that contain a specified user, group, or computer. | v1.5.1.0 |
Get-sqmLoginSettings | Shows all logins with their default database and language setting. | v1.4.7.0 |
Get-sqmSysadminAccounts | Retrieves all logins with sysadmin rights on a SQL Server instance. | v1.0.0.0 |
Grant-sqmTemporarySysadmin | Grants an AD login temporary sysadmin rights for X days and automatically revokes them afterward via a self-deleting SQL Agent job - failover-robust across all replicas for AlwaysOn. | v1.8.1.0 |
Invoke-sqmLoginAudit | Comprehensive audit of all SQL Server logins on one or more instances. | v1.0.0.0 |
Invoke-sqmSaObfuscation | Obfuscates the SA account on a SQL Server instance by renaming it, disabling it, and setting a random password. | v1.0.0.0 |
Invoke-sqmTempSysadminAction | Performs the actual sysadmin grant or revoke on ONE instance - optionally creates a missing AD login, removes it again on revoke, and optionally deletes the calling SQL Agent job after success (self-deleting job). | v1.8.1.0 |
Remove-sqmAdOrphanLogin | Removes Windows logins whose Active Directory account no longer exists (AD orphans). | v1.4.7.0 |
Set-sqmDatabaseOwner | Sets the owner of one or more databases to a uniform login. | v1.0.0.0 |
| Command | Description | Since |
|---|---|---|
Copy-sqmNTFSPermissions | Copies NTFS permissions (ACLs) from a source path to a destination path. | v1.0.0.0 |
Get-sqmAgentJobScheduleReport | Generates a comprehensive SQL Agent Job Schedule Report. | v1.5.1.0 |
Get-sqmConnectionStats | Analyzes active SQL Server connections and connection statistics. | v1.0.0.0 |
Get-sqmDatabaseHealth | Aggregated health report for all databases on an instance. | v1.0.0.0 |
Get-sqmDiskInfoByDriveLetter | Returns disk information for a given drive letter. | v1.2.0.0 |
Get-sqmDiskPartitionMap | Shows the mapping of physical disks to logical drive letters. | v1.7.2.0 |
Get-sqmDiskSpaceReport | Determines free disk space on all SQL-relevant volumes and estimates time to exhaustion based on a self-collected size history. | v1.0.0.0 |
Get-sqmOperationStatus | Displays progress and estimated remaining time for active backup, restore and AutoSeed operations. | v1.0.0.0 |
Get-sqmOrphanedFiles | Finds MDF/LDF/NDF database files that are not assigned to any database. | v1.0.0.0 |
Get-sqmSpnReport | Checks the registered SPNs for SQL Server instances (default and named instances). | v1.0.0.0 |
Get-sqmSQLInstanceCheck | Checks a SQL Server instance against best practices. | v1.0.0.0 |
Get-sqmTempDbRecommendation | Analyzes the TempDB configuration and provides optimization recommendations. | v1.0.0.0 |
Invoke-sqmPatchAnalysis | Compares the installed SQL Server version with known CU/SP builds. | v1.0.0.0 |
Invoke-sqmSetupReport | Professional SQL Server Setup Report with critical issues, security, and database overview. | v1.3.0.0 |
New-sqmAgentProxy | Creates a SQL Server credential and a SQL Agent proxy, and links the two together. | v1.3.0.0 |
New-sqmSetupReport | Builds a self-contained animated HTML replay from a setup event JSON-Lines file. | v1.5.2.0 |
Test-sqmCostThreshold | Checks whether cost threshold for parallelism is at or above the recommended value. | v1.3.0.0 |
Test-sqmTempDbFileCount | Checks whether the number of TempDB data files matches the recommended CPU count. | v1.3.0.0 |
| Command | Description | Since |
|---|---|---|
Get-sqmAutoGrowthReport | Creates an AutoGrowth configuration report for all database files on a SQL Server instance. | v1.0.0.0 |
Get-sqmBlockingReport | Retrieves current blocking chains on a SQL Server instance. | v1.0.0.0 |
Get-sqmDeadlockReport | Reads and analyzes deadlock events from the System Health Extended Event session. | v1.0.0.0 |
Get-sqmIndexFragmentation | Analyzes index fragmentation in one or more databases. | v1.0.0.0 |
Get-sqmLongRunningQueries | Identifies long-running queries on a SQL Server instance. | v1.0.0.0 |
Get-sqmMissingIndexes | Retrieves missing index recommendations from the SQL Server DMV cache. | v1.0.0.0 |
Get-sqmPerfCounters | Reads SQL Server performance counters from sys.dm_os_performance_counters. | v1.0.0.0 |
Get-sqmServerUtilization | Collects SQL Server CPU and memory utilization trends over time. | v1.7.8.0 |
Get-sqmWaitStatistics | Reads and analyzes SQL Server wait statistics from sys.dm_os_wait_stats. | v1.0.0.0 |
Invoke-sqmExtendedEvents | Manages Extended Events sessions for performance analysis on SQL Server. | v1.0.0.0 |
Invoke-sqmPerfBaseline | Creates, compares or lists performance baselines (wait stats + perf counters). | v1.0.0.0 |
Invoke-sqmQueryStore | Configures the Query Store, reads from it, detects issues and saves reports. | v1.0.0.0 |
Invoke-sqmUpdateStatistics | Updates statistics in one or more databases. | v1.0.0.0 |
| Command | Description | Since |
|---|---|---|
Invoke-sqmFormatDrive64k | Checks an NTFS drive for 64 KB allocation unit size and formats it with 65536 byte cluster size if needed. | v1.0.0.0 |
Invoke-sqmNtfsSetup | Grants the SQL Server service accounts NTFS permissions on the instance's data, log, TempDB and backup directories (with an ACL backup beforehand). | v1.5.2.0 |
Test-sqmOlaInstallation | Checks whether Ola Hallengren's Maintenance Solution is installed on a SQL Server instance. | v1.0.0.0 |
Test-sqmSQLFirewall | Tests whether the firewall and network allow a TCP connection to SQL Server. | v1.0.0.0 |
| Command | Description | Since |
|---|---|---|
Compare-sqmServerConfiguration | Vergleicht Konfiguration, Logins und migrationsrelevante Objekte zwischen zwei SQL-Server-Instanzen. | v1.0.0.0 |
Get-sqmServerSetting | Reads one or all server properties from a SQL Server instance. | v1.0.0.0 |
Invoke-sqmCollationChange | Automatically changes the server collation of a SQL Server instance. | v1.0.0.0 |
Invoke-sqmSetDatabaseRecoveryMode | Changes the recovery mode of one or more user databases. | v1.0.0.0 |
Invoke-sqmSsisConfiguration | Configures SQL Server Integration Services (SSIS) fully automatically. Supports standalone and AlwaysOn AG environments, local and remote. | v1.0.0.0 |
Set-sqmMaxDop | Sets MAXDOP (max degree of parallelism) to the recommended (or an explicit) value, and optionally the matching "cost threshold for parallelism". | v1.5.2.0 |
Set-sqmMaxMemory | Sets SQL Server "max server memory (MB)" to the recommended (or an explicit) value. | v1.5.2.0 |
Set-sqmSqlPolicyState | Enables or disables a single Policy-Based Management policy on a SQL Server instance. | v1.0.0.0 |
Set-sqmSsrsConfiguration | Configures SQL Server Reporting Services (SSRS) fully automatically. Supports local and remote installation as well as AlwaysOn environments. | v1.0.0.0 |
Set-sqmTcpPort | Configures the TCP port of a SQL Server instance via the registry. | v1.3.0.0 |
Test-sqmMaxDop | Checks whether MAXDOP (max degree of parallelism) is configured correctly. | v1.3.0.0 |
Test-sqmMaxMemory | Checks whether SQL Server max server memory is configured correctly. | v1.3.0.0 |
| Command | Description | Since |
|---|---|---|
Get-sqmConfig | Returns the current module configuration. | v1.0.0.0 |
Invoke-sqmMonitoringKey | Gets or sets monitoring registry values for the sqmSQLTool on one or more computers. | v1.0.0.0 |
Set-sqmConfig | Sets one or more configuration values for the MSSQLTools module. | v1.0.0.0 |
| Command | Description | Since |
|---|---|---|
Export-sqmDatabaseDocumentation | Creates structured HTML and CSV documentation for all databases on a SQL Server instance. | v1.0.0.0 |
Export-sqmServerConfiguration | Exports all SQL Server configuration settings to a JSON snapshot file. | v1.4.3.0 |
Find-sqmDatabaseObject | Searches all (or selected) databases on an instance for an object name. | v1.0.0.0 |
Get-sqmLinkedServerUsage | Analyzes which database objects (procedures, functions, views, triggers, SQL Agent jobs) access linked servers. | v1.0.0.0 |
Invoke-sqmConfigRollback | Restores SQL Server configuration from a previously exported snapshot. | v1.4.3.0 |
Invoke-sqmInstanceInventory | Creates a complete inventory of a SQL Server instance as a structured report (TXT + CSV). | v1.0.0.0 |
| Command | Description | Since |
|---|---|---|
Get-sqmClusterInfo | Retrieves information about a Windows Failover Cluster: cluster name, nodes and roles including IP addresses. | v1.0.0.0 |
Get-sqmHpuAllowGroup | Searches for the HPU allow group in Active Directory based on configurable domain/group mappings. | v1.0.0.0 |
Test-sqmSsasDirectoryPermissions | Checks and corrects NTFS permissions for SSAS directories (Data, Log, Temp, Backup). | v1.0.0.0 |
Test-sqmSSISPackageCompatibility | Validates SSIS package compatibility for SQL Server upgrades (2016 - 2025). | v1.4.3.0 |
| Command | Description | Since |
|---|---|---|
Get-sqmCertificateReport | Creates a comprehensive report on SQL Server certificates and their expiration dates. | v1.0.0.0 |
Get-sqmTlsStatus | Audits TLS/SSL configuration and certificate status for all SQL Server instances on one or more computers. | v1.2.0.0 |
Install-sqmCertificate | Installs a certificate (self-signed or CA-signed) in SQL Server and automatically binds it to the configured purpose. | v1.0.0.0 |
Install-sqmCertificateToStore | Installs a certificate file into the Windows certificate store - locally or on multiple remote computers. | v1.2.0.0 |
New-sqmCertificateRequest | Creates a CSR (Certificate Signing Request) and an order data sheet for a CA-signed certificate based on an existing SQL Server certificate. | v1.0.0.0 |
New-sqmSqlCertificate | Creates a new self-signed SQL Server certificate as a renewal of an existing one. | v1.0.0.0 |
Set-sqmSqlTlsCertificate | Binds a Windows certificate from the Machine store to SQL Server as the TLS certificate. | v1.2.0.0 |
Set-sqmSsrsHttpsCertificate | Binds a Windows certificate to SSRS or Power BI Report Server for HTTPS access. | v1.2.0.0 |
| Command | Description | Since |
|---|---|---|
Get-sqmTsmConfiguration | Reads the IBM TSM / Spectrum Protect client configuration (dsm.opt) and returns server, user and password settings. | v1.0.0.0 |
Invoke-sqmTsmConfiguration | Configures the IBM Spectrum Protect (TSM) client options file dsm.opt for use with SQL Server backup directories. | v1.0.0.0 |
Test-sqmTsmConnection | Tests the connection to an IBM Spectrum Protect (TSM) server using dsmadmc. | v1.0.0.0 |
| Command | Description | Since |
|---|---|---|
Install-sqmDb2Driver | Installs the IBM DB2 ODBC/CLI driver. | v1.3.0.0 |
Install-sqmJdbcDriver | Installs the Microsoft JDBC Driver for SQL Server. | v1.3.0.0 |
Install-sqmOdbcDriver | Installs the Microsoft ODBC Driver for SQL Server. | v1.3.0.0 |
Test-sqmDriverInstalled | Checks whether a JDBC, ODBC, or DB2 driver is installed on the system. | v1.3.0.0 |
Uninstall-sqmDb2Driver | Uninstalls the IBM DB2 ODBC/CLI driver. | v1.3.0.0 |
Uninstall-sqmJdbcDriver | Uninstalls the Microsoft JDBC Driver for SQL Server. | v1.3.0.0 |
Uninstall-sqmOdbcDriver | Uninstalls the Microsoft ODBC Driver for SQL Server. | v1.3.0.0 |
| Command | Description | Since |
|---|---|---|
Install-sqmSsrsReportServer | Installs SQL Server Reporting Services 2022 from a network share and automatically configures the instance afterwards. | v1.0.0.0 |
Invoke-sqmDeployScripts | Executes numbered SQL scripts from a directory sequentially against a SQL Server database. | v1.2.0.0 |
Invoke-sqmSignModule | Signs all PowerShell script files in a module directory using Set-AuthenticodeSignature. | v1.2.0.0 |
| Command | Description | Since |
|---|---|---|
Copy-sqmLogins | Copies logins from a source SQL Server instance to a target instance. | v1.0.0.0 |
Copy-sqmToCentralPath | Copies one or more files to the configured CentralPath. | v1.0.0.0 |
Get-sqmAgentJobHistory | Displays the execution history of SQL Agent jobs. | v1.0.0.0 |
Get-sqmDiskBlockSize | Checks the NTFS block size (cluster size) of drives against 64KB. | v1.3.0.0 |
Get-sqmServerHardwareReport | Creates an HTML hardware configuration report for one or more servers. | v1.4.0.0 |
Install-sqmAdModule | Ensures that the ActiveDirectory PowerShell module (RSAT) is installed. | v1.0.0.0 |
Install-sqmOlaMaintenanceSolution | Installs or updates Ola Hallengren's Maintenance Solution on a SQL Server instance. | v1.0.0.0 |
install-sqmolammaintenance solution | — | — |
Invoke-sqmSplunkConfiguration | Configures the Splunk Universal Forwarder on SQL Server hosts. | v1.0.0.0 |
New-sqmOlaMaintenanceJobs | Creates three SQL Agent jobs for Ola Hallengren's Maintenance Solution: IndexOptimize (user DBs) and IntegrityCheck (user and system DBs). | v1.0.0.0 |
New-sqmRandomSaPassword | Generates a random, policy-compliant SA password. | v1.3.0.0 |
repair-sqmalwaysondbases | — | — |
Show-sqmToolGui | Launches a small graphical interface (WinForms) for all sqmSQLTool functions. | v1.5.2.0 |
Test-sqmSqlInstanceInstalled | Checks whether a SQL Server instance is installed on the local system. | v1.3.0.0 |
Write-sqmSetupEvent | Appends a single structured setup event as one JSON line (JSON-Lines) to a file. | v1.5.2.0 |