Invoke-sqmSSISConfiguration
ConfigurationsqmSQLTool v1.8.2+ · SSIS Setup⚠ Requires SQL 2012+ ✓ Full Catalog Config
Parameters
| Parameter | Type | Required | Default | Notes |
|---|---|---|---|---|
| -SqlInstance | string | Optional | $env:COMPUTERNAME | Target SQL Server instance (SSIS host). |
| -SqlCredential | PSCredential | Optional | , | Credentials for SSIS connection. |
| -EnableException | switch | Switch | $false | Re-throw exceptions immediately. |
| -WhatIf / -Confirm | switch | Optional | , | ShouldProcess (ConfirmImpact: Medium) guards configuration. |
| -AgListener | string | Optional | , | AG listener name (automatically determined if not specified). |
| -AgName | string | Optional | , | Name of the AlwaysOn Availability Group (optional). |
| -AgNodes | string[] | Optional | , | Explicit list of all AG nodes (optional). |
| -CatalogFolder | string[] | Optional | , | Array of catalog folder names (e.g. @('ETL','Staging')). |
| -CatalogFolderDescription | string | Optional | 'Angelegt von MSSQLTools' | Description for the folders (default: 'Created by MSSQLTools'). |
| -CatalogPassword | SecureString | Required | , | Password for the SSISDB catalog (SecureString, required). |
| -ContinueOnError | switch | Switch | $false | Continue with the next step on error (rarely used). |
| -Environments | string[] | Optional | , | Array of environment names (created in each CatalogFolder). |
| -LoggingLevel | int | Optional | 1 | Logging level (0=None, 1=Basic, 2=Performance, 3=Verbose; default: 1). |
| -MaxConcurrentExecutables | int | Optional | -1 | Maximum concurrent executions (default: -1 = unlimited). |
| -OutputPath | string | Optional | (Get-sqmDefaultOutputPath) | Output directory for the configuration report. Default: Get-sqmDefaultOutputPath. |
| -RetentionPeriod | int | Optional | 365 | Retention period for SSISDB logs in days (default: 365). |
| -SkipAg | switch | Switch | $false | Skip AG integration (even if -AgName is specified). |
| -SkipCatalog | switch | Switch | $false | Skip catalog creation/configuration. |
| -SkipFolders | switch | Switch | $false | Skip folder/environment creation. |
| -SkipService | switch | Switch | $false | Skip service configuration. |
| -SsisServiceAccount | string | Optional | , | Service account for the SSIS service (e.g. 'DOMAIN\svc_ssis'). |
| -SsisServiceAccountPassword | SecureString | Optional | , | Password for the service account (SecureString). |
| -SsisServiceStartupType | string | Optional | 'Automatic' | Startup type of the SSIS service (Automatic, Manual, Disabled; default: Automatic). |
| -WinRmCredential | PSCredential | Optional | , | Credentials for WinRM (remote service configuration, optional). |
Execution Flow
Examples
Create SSIS Catalog
Invoke-sqmSSISConfiguration -SqlInstance "SQL01" -Action "CreateCatalog"
Create folder and set retention policy
Invoke-sqmSSISConfiguration -SqlInstance "SQL01" -Action "CreateFolder" -FolderName "Production" -FolderDescription "Production SSIS Projects" Invoke-sqmSSISConfiguration -SqlInstance "SQL01" -Action "ConfigurePolicy" -RetentionDays 180