Introduction

The xSCOM module is a part of the Windows PowerShell Desired State Configuration (DSC) Resource Kit, which is a collection of DSC Resources produced by the PowerShell Team. This module contains the following resources for installation of System Center Operations Manager (OM):

• xSCOMManagementServerSetup for installation of the OM Management server,
• xSCOMReportingServerSetup for installation of the OM Reporting server,
• xSCOMWebConsoleServerSetup for installation of the OM Web Console server,
• xSCOMConsoleSetup for installation of the OM console,
• xSCOMManagementServerUpdate for updating an OM Management server to Update Rollup 4,
• xSCOMWebConsoleServerUpdate for updating an OM Web Console server to Update Rollup 4,
• xSCOMConsoleUpdate for updating an OM Console to Update Rollup 4,
• xSCOMAdmin for adding OM admins,
• xSCOMManagementPack for installing OM Management Packs.

All of the resources in the DSC Resource Kit are provided AS IS, and are not supported through any Microsoft standard support program or service. The ""x" in xSCOM stands for experimental, which means that these resources will be fix forward and monitored by the module owner(s).

Please leave comments, feature requests, and bug reports in the Q & A tab for this module.

If you would like to modify xSCOM module, feel free. When modifying, please update the module name, resource friendly name, and MOF class name (instructions below). As specified in the license, you may copy or modify this resource as long as they are used on the Windows Platform.

For more information about Windows PowerShell Desired State Configuration, check out the blog posts on the PowerShell Blog (this is a good starting point). There are also great community resources, such as PowerShell.org, or PowerShell Magazine. For more information on the DSC Resource Kit, check out this blog post.

Installation

To install the xSCOM module

• If you are using WMF4 / PowerShell Version 4: Unzip the content under $env:ProgramFiles\WindowsPowerShell\Modules folder
• If you are using WMF5 Preview: From an elevated PowerShell session run ‘Install-Module xScom’

To confirm installation:

• Run Get-DSCResource to see that xSCOMManagementServerSetup, xSCOMReportingServerSetup, xSCOMWebConsoleServerSetup, xSCOMConsoleSetup, and xSCOMManagementPack are among the DSC Resources listed.
  

Requirements

This module requires at least PowerShell v4.0, which ships in Windows 8.1 or Windows Server 2012R2. To easily use PowerShell 4.0 on older operating systems, install WMF 4.0. Please read the installation instructions that are present on both the download page and the release notes for WMF 4.0.

Description

The xSCOM module contains the - xSCOMManagementServerSetup, xSCOMReportingServerSetup, xSCOMWebConsoleServerSetup, xSCOMConsoleSetup, xSCOMManagementServerUpdate, xSCOMWebConsoleServerUpdate, xSCOMConsoleUpdate, xSCOMAdmin, and xSCOMManagementPack DSC Resources. This DSC Module enables installation of System Center Operations Manager.

Details

xSCOMManagementServerSetup is used for for installation of the OM Management server. xSCOMManagementServerSetup has the following properties:

• Ensure: KEY - An enumerated value (Present, Absent) that describes if the OM management server is expected to be installed on the machine.
• SourcePath: REQUIRED - UNC path to the root of the source files for installation.
• SourceFolder: Folder within the source path containing the source files for installation.
• SetupCredential: REQUIRED - Credential to be used to perform the installation.
• ProductKey: Product key for licensed installations.
• InstallPath: Installation path for the software.
• ManagementGroupName: REQUIRED - The name of the management group.
• FirstManagementServer: REQUIRED - Is this a boolean indicating if this is the first Management Server.
• ManagementServicePort: Change the Management Server port on install.
• ActionAccount: The domain and user name of the Management server action account.
• ActionAccountUsername: Output username of the Management server action account.
• DASAccount: The domain and user name of the Data Access service account.
• DASAccountUsername: Output username of the Data Access service account.
• DataReader: REQUIRED - The domain and user name of the data reader account.
• DataReaderUsername: Output username of the data reader account.
• DataWriter: REQUIRED - The domain and user name of the data Writer account.
• DataWriterUsername: Output username of the data writer account.
• SqlServerInstance: REQUIRED - The SQL server and instance.
• DatabaseName: The name of the Operational database
• DatabaseSize: The size in MB of the Operational database.
• DwSqlServerInstance: REQUIRED - The data warehouse server and instance.
• DwDatabaseName: The name of the data warehouse database.
• DwDatabaseSize: The size in MB of the data warehouse database.
• UseMicrosoftUpdate: Enumerated value - 0: Do not opt in to Microsoft Update. 1: Opt in to Microsoft Update.
• SendCEIPReports: Enumerated value - 0: Do not opt in to the Customer Experience Improvement Program (CEIP). 1: Opt in to CEIP.
• EnableErrorReporting: Enumerated value - Never: Do not opt in to sending automatic error reports. Queued: Opt in to sending error reports, but queue the reports for review before sending. Always: Opt in to automatically send error reports.
• SendODRReports: Enumerated value - 0: Do not opt in to sending operational data reports. 1: opt in to sending operational data reports.

xSCOMReportingServerSetup is used for installation of the OM Reporting server. It has the following properties:

• Ensure: KEY - An enumerated value (Present, Absent) that describes if the OM management server is expected to be installed on the machine.
• SourcePath: REQUIRED - UNC path to the root of the source files for installation.
• SourceFolder: Folder within the source path containing the source files for installation.
• SetupCredential: REQUIRED - Credential to be used to perform the installation.
• InstallPath: Installation path for the software.
• ManagementServer: REQUIRED - The name of the management server associated with the Reporting server.
• SRSInstance: REQUIRED - The reporting server and instance.
• DataReader: REQUIRED - The domain and user name of the data reader account.
• DataReaderUsername: Output username of the data reader account.
• UseMicrosoftUpdate: Enumerated value - 0: Do not opt in to Microsoft Update. 1: Opt in to Microsoft Update.
• SendCEIPReports: Enumerated value - 0: Do not opt in to the Customer Experience Improvement Program (CEIP). 1: Opt in to CEIP.
• EnableErrorReporting: Enumerated value - Never: Do not opt in to sending automatic error reports. Queued: Opt in to sending error reports, but queue the reports for review before sending. Always: Opt in to automatically send error reports.
• SendODRReports: Enumerated value - 0: Do not opt in to sending operational data reports. 1: opt in to sending operational data reports.

xSCOMWebConsoleServerSetup is used for installation of the OM Web Console server, and has the following properties:

• Ensure: KEY - An enumerated value (Present, Absent) that describes if the OM management server is expected to be installed on the machine.
• SourcePath: REQUIRED - UNC path to the root of the source files for installation.
• SourceFolder: Folder within the source path containing the source files for installation.
• SetupCredential: REQUIRED - Credential to be used to perform the installation.
• InstallPath: Installation path for the software.
• ManagementServer: REQUIRED - The name of the management server associated with the Reporting server.
• WebSiteName: The name of the website.
• WebConsoleAuthorizationMode: Mixed: Used for intranet scenarios. Network: Used for extranet scenarios.
• WebConsoleUseSSL: Specify only if your website has Secure Sockets Layer (SSL) activated.
• UseMicrosoftUpdate: Enumerated value - 0: Do not opt in to Microsoft Update. 1: Opt in to Microsoft Update.
• SendCEIPReports: Enumerated value - 0: Do not opt in to the Customer Experience Improvement Program (CEIP). 1: Opt in to CEIP.
• EnableErrorReporting: Enumerated value - Never: Do not opt in to sending automatic error reports. Queued: Opt in to sending error reports, but queue the reports for review before sending. Always: Opt in to automatically send error reports.
• SendODRReports: Enumerated value - 0: Do not opt in to sending operational data reports. 1: opt in to sending operational data reports.

xSCOMConsoleSetup is used for installation of the OM console, and has the following properties:

• Ensure: KEY - An enumerated value (Present, Absent) that describes if the OM management server is expected to be installed on the machine.
• SourcePath: REQUIRED - UNC path to the root of the source files for installation.
• SourceFolder: Folder within the source path containing the source files for installation.
• SetupCredential: REQUIRED - Credential to be used to perform the installation.
• InstallPath: Installation path for the software.
• UseMicrosoftUpdate: Enumerated value - 0: Do not opt in to Microsoft Update. 1: Opt in to Microsoft Update.
• SendCEIPReports: Enumerated value - 0: Do not opt in to the Customer Experience Improvement Program (CEIP). 1: Opt in to CEIP.
• EnableErrorReporting: Enumerated value - Never: Do not opt in to sending automatic error reports. Queued: Opt in to sending error reports, but queue the reports for review before sending. Always: Opt in to automatically send error reports.
• SendODRReports: Enumerated value - 0: Do not opt in to sending operational data reports. 1: opt in to sending operational data reports.

xSCOMManagementServerUpdate has the following properties:

• Ensure: KEY - An enumerated value that describes if the update is expected to be installed on the machine.
• SourcePath: REQUIRED - UNC path to the root of the source files for installation.
• SourceFolder: Folder within the source path containing the source files for installation.
• Credential: REQUIRED - Credential to be used to perform the installation.
• Update: Output display name of the update.

xSCOMWebConsoleServerUpdate has the following properties:

• Ensure: KEY - An enumerated value that describes if the update is expected to be installed on the machine.
• SourcePath: REQUIRED - UNC path to the root of the source files for installation.
• SourceFolder: Folder within the source path containing the source files for installation.
• Credential: REQUIRED - Credential to be used to perform the installation.
• Update: Output display name of the update.

xSCOMConsoleUpdate has the following properties:

• Ensure: KEY - An enumerated value that describes if the update is expected to be installed on the machine.
• SourcePath: REQUIRED - UNC path to the root of the source files for installation.
• SourceFolder: Folder within the source path containing the source files for installation.
• Credential: REQUIRED - Credential to be used to perform the installation.
• Update: Output display name of the update.

xSCOMAdmin has the following properties:

• Ensure: An enumerated value that describes if the principal is an Operations Manager admin.
• Principal: KEY - The Operations Manager admin principal.
• UserRole: KEY - The Operations Manager user role.
• SCOMAdminCredential: REQUIRED - Credential to be used to perform the operations.

xSCOMManagementPack has the following properties:

• Name: KEY - Name of the Management Pack.
• Version: Specific version of the Management Pack, overrides MinVersion if both set.
• MinVersion: Minimum version of the Management Pack, overridden by Version if both set.
• SCOMAdminCredential: REQUIRED - Credential with admin permissions to Operations Manager.
• SourcePath: REQUIRED - UNC path to the root of the source files for installation.
• SourceFolder: Folder within the source path containing the source files for installation.
• SourceFile: Name of the file in the source folder for the Management Pack.

Renaming Requirements

When making changes to these resources, we suggest the following practice:

1. Update the following names by replacing MSFT with your company/community name and replacing the "x" with "c" (short for "Community") or another prefix of your choice:
   • Module name (ex: xSCOM becomes cSCOM)
   • Resource folder (ex: MSFT_xSCOMConsoleSetup becomes Contoso_cSCOMConsoleSetup)
   • Resource Name (ex: MSFT_xSCOMConsoleSetup becomes Contoso_cSCOMConsoleSetup)
   • Resource Friendly Name (ex: xSCOMConsoleSetup becomes cSCOMConsoleSetup)
   • MOF class name (ex: MSFT_xSCOMConsoleSetup becomes Contoso_cSCOMConsoleSetup)
   • Filename for the <resource>.schema.mof (ex: MSFT_xSCOMConsoleSetup.schema.mof becomes Contoso_cSCOMConsoleSetup.schema.mof)
2. Update module and metadata information in the module manifest
3. Update any configuration that use these resources

We reserve resource and module names without prefixes ("x" or "c") for future use (e.g. "MSFT_SCOMConsoleSetup" or "SCOMConsoleSetup"). If the next version of Windows Server ships with "MSFT_SCOMConsoleSetup" resources, we don't want to break any configurations that use any community modifications. Please keep a prefix such as "c" on all community modifications.

Versions

1.3.3.0

• Increased timeout for setup process to start to 60 seconds.
• Modified MSFT_xSCOMConsoleUpdate, MSFT_xSCOMManagementServerUpdate, and MSFT_xSCOMWebConsoleServerUpdate resources to use /norestart, allowing DSC to control reboots.

1.2.0.0

• Updated to include following resources:
  • xSCOMManagementServerUpdate
  • xSCOMWebConsoleServerUpdate
  • xSCOMConsoleUpdate
  • xSCOMAdmin
  • xSCOMManagementPack

1.1.0.0

• Initial release with the following resources
  • xSCOMManagementServerSetup
  • xSCOMConsoleSetup
  • xSCOMReportingServerSetup,
  • xSCOMWebConsoleServerSetup

Examples

Four example configurations are included in the Examples folder within the module. All four examples also use xCredSSP and xSQLServer modules. Note: the samples require the use of the Windows Management Framework (WMF) 5.0 Preview.

Single Server Installation: SCOM-SingleServer.ps1 installs all OM roles including prerequisites and SQL on a single server.

Separate SQL: SCOM-SeperateSQL.ps1 installs all OM roles on one server and SQL on a seperate server.

Multiple Separate SQL Instances: SCOM-SeperateSQLInstances.ps1 installs all OM roles on one server and SQL in multiple instances on a seperate server.

Multiple Management Servers: SCOM-MultiInstance.ps1 installs all OM roles including multiple Management servers each on their own server with multiple SQL Servers.

In the Examples folder you will see a version of each file with "-TP" appended to the name. These are the equivalent examples for deployment of System Center Technical Preview on Windows Server Technical Preview.