Export-SCOMEffectiveMonitoringConfiguration

[This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Export-SCOMEffectiveMonitoringConfiguration

Retrieves the rules, monitors, and overrides that apply to a specified monitoring object, calculates the effective configuration of the rules and monitors, and then sends the output to a CSV file that can be imported into a program such as Microsoft Excel. The delineator used in the CSV file is the pipeline symbol, "|".

Syntax

Parameter Set: Empty
Export-SCOMEffectiveMonitoringConfiguration [-Instance] <MonitoringObject> [-Path] <String> [-ComputerName <String> ] [-Credential <PSCredential> ] [-Encoding <Encoding> ] [-RecurseContainedObjects] [-SCSession <Connection> ] [ <CommonParameters>]

Detailed Description

The Export-SCOMEffectiveMonitoringConfiguration cmdlet retrieves the rules, monitors, and overrides that apply to a specified monitoring object, calculates the effective configuration of the rules and monitors, and then sends the output to a CSV file that can be imported into a program such as Microsoft Excel. The delineator used in the CSV file is the pipeline symbol, "|".

Parameters

-ComputerName<String>

Specifies the name of a computer to establish a connection with. The computer must be running the System Center Data Access Service. The default value is the computer for the current management group connection. Valid formats include a NetBIOS name, an IP address, or a fully qualified domain name. To specify the local computer, type the computer name, "localhost", or a dot (.).

-Credential<PSCredential>

Specifies a user account under which the management group connection will run. The default is the current user. Type a user name, such as "User01", "Domain01\User01", or "User@Domain.com", or enter a PSCredential object, such as one returned by the Get-Credential cmdlet. When you type a user name, you will be prompted for a password. For more information, type Get-Help Get-Credential.

-Instance<MonitoringObject>

Specifies one or more class instance objects. Enter a variable that represents the class instances, or type a command that gets the class instances. This parameter also accepts group objects.For information about how to get a class instance object, type Get-Help Get-SCOMClassInstance.

-Path<String>

Specifies the path and filename where the resulting CSV file should be stored. A file extension is not appended by default, therefore one must be provided.

-RecurseContainedObjects

Indicates whether the data for objects that are contained by the MonitoringObject are included in the output. For example, in the case of a computer, RecurseContainedObjects returns all discoveries and monitors on the computer and all monitoring objects hosted on the computer, such as disks or network cards.

-SCSession<Connection>

Specifies a connection to a management server. The default is the current management group connection. Specify a Management group connection object, such as one returned by the Get-SCOMManagementGroupConnection cmdlet.

-Encoding<Encoding>

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters

Examples

-------------------------- EXAMPLE 1 --------------------------

Description-----------The first command gets the group members of the All Windows Computers group and stores the objects in the $Members object array. The second command uses the pipeline operator to pass each object stored in $Members to a ForEach statement that exports the data to a CSV file at the specified location, including the name of the computer in the file name, and appending a .csv extension.

PS C:\>$members = (Get-SCOMGroup –DisplayName “All Windows Computers”).GetRelatedMonitoringObjects()

PS C:\> $members | foreach { Export-SCOMEffectiveMonitoringConfiguration –Instance $_ -Path “C:\temp\$($_.DisplayName).csv” } –RecurseContainedObjects }