{"id":20156187,"url":"https://github.com/dsccommunity/xscsma","last_synced_at":"2025-12-11T21:38:02.710Z","repository":{"id":30468266,"uuid":"34022252","full_name":"dsccommunity/xSCSMA","owner":"dsccommunity","description":null,"archived":false,"fork":false,"pushed_at":"2019-09-19T02:28:35.000Z","size":178,"stargazers_count":14,"open_issues_count":3,"forks_count":14,"subscribers_count":18,"default_branch":"dev","last_synced_at":"2025-03-22T04:49:06.996Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dsccommunity.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-04-15T22:43:06.000Z","updated_at":"2024-09-01T22:57:09.000Z","dependencies_parsed_at":"2022-08-22T23:40:32.659Z","dependency_job_id":null,"html_url":"https://github.com/dsccommunity/xSCSMA","commit_stats":null,"previous_names":["powershell/xscsma"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsccommunity%2FxSCSMA","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsccommunity%2FxSCSMA/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsccommunity%2FxSCSMA/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsccommunity%2FxSCSMA/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dsccommunity","download_url":"https://codeload.github.com/dsccommunity/xSCSMA/tar.gz/refs/heads/dev","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248120108,"owners_count":21050893,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T23:37:55.315Z","updated_at":"2025-12-11T21:38:02.637Z","avatar_url":"https://github.com/dsccommunity.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build status](https://ci.appveyor.com/api/projects/status/xihqaoojlad4nb43/branch/master?svg=true)](https://ci.appveyor.com/project/PowerShell/xscsma/branch/master)\r\n\r\n# xSCSMA\r\n\r\nThe **xSCSMA** module contains DSC resources for installation of System Center Service Management Automation (SMA).\r\n\r\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).\r\nFor more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.\r\n\r\n## Contributing\r\nPlease check out common DSC Resources [contributing guidelines](https://github.com/PowerShell/DscResource.Kit/blob/master/CONTRIBUTING.md).\r\n\r\n\r\n## Resources\r\n\r\n* **xSCSMAPowerShellSetup** installs SMA PowerShell\r\n* **xSCSMAWebServiceServerSetup** installs an SMA Web Service server\r\n* **xSCSMARunbookWorkerServerSetup** installs an SMA Runbook Worker server\r\n* **xRunbookDirectory** imports Runbook(s) to an SMA instance\r\n* **xSmaVariable** Imports SMA variable to an SMA instance\r\n* **xSmaCredential** Imports SMA Credentials to an SMA instance\r\n\r\n### xSCSMAPowerShellSetup\r\n\r\n* **Ensure**: (Key) Ensures that the SMA PowerShell components are **Present** or **Absent** on the machine.\r\n* **SourcePath**: (Required) UNC path to the root of the source files for installation.\r\n* **SourceFolder**: Folder within the source path containing the source files for installation.\r\n* **SetupCredential**: (Required) Credential to be used to perform the installation.\r\n\r\n### xSCSMAWebServiceServerSetup\r\nUsed for installation of the SMA Web Service server.\r\n\r\n* **Ensure**: (Key) Ensures that the SCSCMA Web Service server components are **Present** or **Absent** on the machine.\r\n* **SourcePath**: (Required) UNC path to the root of the source files for installation.\r\n* **SourceFolder**: Folder within the source path containing the source files for installation.\r\n* **SetupCredential**: (Required) Credential to be used to perform the installation.\r\n* **FirstWebServiceServer**: (Required) Binary value defining if this the first Management Server\r\n* **ApPool**: (Required) Service account of the web service application pool.\r\n* **ApPoolUsername**: Output user name of the web service application pool.\r\n* **AdminGroupMembers**: A comma-separated list of users to add to the IIS Administrators group.\r\n* **SqlServer**: (Required) Name of the SQL Server for the SMA database.\r\n* **SqlInstance**: (Required) Name of the SQL Instance for the SMA database.\r\n* **SqlDatabase**: Name of the SMA database.\r\n* **SiteName**: Name of the SMA website.\r\n* **WebServicePort**: Port of the SMA website.\r\n* **InstallFolder**: Installation folder for SMA.\r\n* **UseSSL**: { **Yes** | No } Defining whether or not to use SSL. Default value is **Yes**.\r\n* **SpecifyCertificate**: { Yes | **No** } Specify an existing certificate for the SMA web site. Default value is **No**.\r\n* **CertificateName**: Name of the existing certificate to use.\r\n* **ETWManifest**: { **Yes** | No } Log to ETW. Default value is **Yes**.\r\n* **SendTelemetryReports**: { Yes | **No** } Usage and Diagnostics Data sent to Microsoft. Default value is **No**.\r\n* **MSUpdate**: { Yes | **No** } Opt in to Microsoft Update. Default value is **No**.\r\n* **ProductKey**: Product key for licensed installations.\r\n* **RunbookWorkerServers**: Array of Runbook Worker servers in this deployment.\r\n* **LogMsiInstall**: Controlls if MSI installation is logged {True | False}.\r\n* **MsiLogPath**: Path to put MSI logfile in.\r\n* **MsiLogName**: Name of MSI log file.\r\n\r\n### xSCSMARunbookWorkerServerSetup\r\n\r\n* **Ensure**: (Key) Ensures that the SMA Runbook Worker server is **Present** or **Absent** on the machine.\r\n* **SourcePath**: (Required) UNC path to the root of the source files for installation.\r\n* **SourceFolder**: Folder within the source path containing the source files for installation.\r\n* **SetupCredential**: (Required) Credential to be used to perform the installation.\r\n* **Service**: (Required) Service account of the web service application pool.\r\n* **ServiceUserName**: Output user name of the Service account of the web service application pool.\r\n* **SqlServer**: (Required) Name of the SQL Server for the SMA database.\r\n* **SqlInstance**: (Required) Name of the SQL Instance for the SMA database.\r\n* **SqlDatabase**: Name of the SMA database.\r\n* **InstallFolder**: Installation folder for SMA.\r\n* **ETWManifest**: { **Yes** | No } Log to ETW. Default value is **Yes**.\r\n* **SendTelemetryReports**: { Yes | **No** } Usage and Diagnostics Data sent to Microsoft. Default value is **No**.\r\n* **MSUpdate**: { Yes | **No** } Opt in to Microsoft Update. Default value is **No**.\r\n* **ProductKey**: Product key for licensed installations.\r\n* **LogMsiInstall**: Controlls if MSI installation is logged {True | False}.\r\n* **MsiLogPath**: Path to put MSI logfile in.\r\n* **MsiLogName**: Name of MSI log file.\r\n\r\n### xRunbookDirectory\r\nImports runbook(s) into an SMA instance. The Workflow name is expected to match the name of the ps1, and will become the name of the Runbooks.\r\n\r\n* **RunbookPath**: (Key) Path to Runbook(s) to be imported. Accepts wildcards.\r\n* **Ensure**: (Required) The import state of runbooks found at RunbookPath. This can be Published, Draft, or Absent.\r\n* **WebServiceEndpoint**: (Key) The web service endpoint of the SMA instance to import the Runbook too.\r\n* **Port**: Port to reach the web service endpoint. Default value is 9090.\r\n\r\n### xSmaVariable\r\n\r\n* **Ensure** (Required) Ensures that the SMA variable is **Present** or **Absent** at the web service endpoint.\r\n* **Name** (Key) Name of variable.\r\n* **Value** (Required) Value of variable.\r\n* **Description** Description of variable.\r\n* **WebServiceEndpoint** (Key) Web service endpoint of SMA instance.\r\n* **Port** Port to reach the web service endpoint. Default value is 9090.\r\n\r\n### xSmaCredential\r\n\r\n* **Name** (Key) Name of credential.\r\n* **Credential** (Required) Credential object to be imported.\r\n* **Description** Description of credential.\r\n* **WebServiceEndpoint** (Required) Web service endpoint of SMA instance.\r\n* **Port** Port to reach the web service endpoint.\r\n\r\n## Versions\r\n\r\n### Unreleased\r\n\r\n### 2.1.0.0\r\n\r\n* Update appveyor.yml to use the default template.\r\n* Added default template files .codecov.yml, .gitattributes, and .gitignore, and\r\n  .vscode folder.\r\n* Closed issue #29 - Web bindings fail due to hardcoded WSE\r\n* Switched from Get-WmiObject Win32_Product to Get-ItemProperty for identifer number\r\n\r\n### 2.0.0.0\r\n\r\n* Added MSI install logging for MSFT_xSCSMARunbookWorkerServerSetup and MSFT_xSCSMARunbookWorkerServerSetup\r\n* Added missing -Port parameter argument for New-SmaRunbookWorkerDeployment in MSFT_xSCSMARunbookWorkerServerSetup\r\n* Fixed MSFT\\_xSCSMARunbookWorkerServerSetup and MSFT\\_xSCSMAWebServiceServerSetup using incorrect executable for version checking\r\n* Remove System Center Technical Preview 5 support. Close issue #18\r\n* Close issue #19 (always install self-signed certificate)\r\n* BREAKING CHANGE: change SendCEIPReports parameter to SendTelemetryReports. Close issue #20\r\n* Added description for new parameters at README.md\r\n* Fix return state of the current SendTelemetryReports\r\n* Fix syntax at source code\r\n\r\n### 1.5.0.0\r\n\r\n* Added $IdentifyingNumber for TP5/RTM and small WMI improvements\r\n\r\n### 1.4.0.0\r\n* Converted appveyor.yml to install Pester from PSGallery instead of from Chocolatey.\r\n\r\n* Added new example to show how to use xRunbookDirectory to remove all SMA sample Runbooks\r\n* Added new resource xSmaCredential.\r\n\r\n### 1.3.0.0\r\n\r\n* Added new resource to manage a single or directory of Runbooks, xRunbookDirectory.\r\n* Added xSmaVariable resource.\r\n\r\n### 1.2.1.0\r\n\r\n* Increased timeout for setup process to start to 60 seconds.\r\n* xSCSMAWebServiceServerSetup\r\n    - Fixed bug when using named SQL instance\r\n    - Added SMA service account to admin group.\r\n* xSCSMARunbookWorkerSetup\r\n    - Fixed bug when using named SQL instance.\r\n\r\n### 1.1.0.0\r\n\r\n* Initial release with the following resources:\r\n    * xSCSMAPowerShellSetup\r\n    * xSCSMAWebServiceServerSetup\r\n    * xSCSMARunbookWorkerServerSetup\r\n\r\n## Examples\r\n\r\nThree example configurations are included in the Examples folder. All three examples also use the xSQLServer module.\r\n\r\n### Single Server Installation\r\n\r\nSCSMA-SingleServer.ps1 installs all SMA roles including prerequisites and SQL on a single server.\r\n\r\n### Separate SQL\r\n\r\nSCSMA-SeperateSQL.ps1 installs all SMA roles on one server and SQL on a separate server.\r\n\r\n### Multiple Instances\r\n\r\nSCSMA-MultiInstance.ps1 installs all SMA roles including multiple instances of both Web Service and Runbook Worker servers and SQL on a separate server.\r\n\r\n### Remove Sample Runbooks\r\n\r\nRemoveSampleRunbooks.ps1 removes SMA's default sample Runbooks.\r\n\r\n###  Runbook Directory\r\n\r\nRunbookDirectory.ps1 imports all Runbooks found in a directory that start with the name \"Start-\" and publishes them.\r\n\r\n### SMA Variable\r\n\r\nSmaVariable.ps1 adds a variable named \"Variable\" with value \"Value\"\r\n\r\nNotes:\r\n\r\nThe Single Server Installation, Separate SQL, and Multiple Instances examples use the exact same Configuration and just modify the behavior based on input ConfigurationData.\r\n\r\nIn the Examples folder you will see a version of each file with \"-TP\" appended to the name.\r\nThese are the equivalent examples for deployment of System Center Technical Preview on Windows Server Technical Preview.\r\n\r\nThe samples require the use of the [Windows Management Framework (WMF) 5.0 Preview.](http://go.microsoft.com/fwlink/?LinkId=398175)\r\n\r\nSystem Center 2012 R2 Service Management Automation Web Service and Runbook Worker installers have a hard check for PowerShell 4.0.\r\nIf you are using these resources to install on a system that has WMF 5.0 preview installed, you must copy the transform (MST) files from the Web Service and Runbook Worker DSC resource folders to the SMA installation folder.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsccommunity%2Fxscsma","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdsccommunity%2Fxscsma","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsccommunity%2Fxscsma/lists"}