Export-SCOMEffectiveMonitoringConfiguration
Export-SCOMEffectiveMonitoringConfiguration
Exports configuration applicable to a monitoring object.
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 saves the results to a .csv file. This file uses the pipe symbol (|) as a separator.
By default, this cmdlet uses the active persistent connection to a management group. Use the SCSession parameter to specify a different persistent connection. You can create a temporary connection to a management group by using the ComputerName and Credential parameters. For more information, type Get-Help about_OpsMgr_Connections.
Parameters
-ComputerName<String[]>
Specifies an array of names of computers. The cmdlet establishes temporary connections with management groups for these computers. You can use NetBIOS names, IP addresses, or fully qualified domain names (FQDNs). To specify the local computer, type the computer name, localhost, or a dot (.).
The System Center Data Access service must be running on the computer. If you do not specify a computer, the cmdlet uses the computer for the current management group connection.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies a PSCredential object for the management group connection. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.
If you specify a computer in the ComputerName parameter, use an account that has access to that computer. The default is the current user.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Encoding<Encoding>
Specifies the encoding to use for the monitoring configuration.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Instance<MonitoringObject>
Specifies an array of monitoring objects that represent instances. To obtain a class instance object, use the Get-SCOMClassInstance cmdlet.
This parameter also accepts group objects. To obtain a group object, use the Get-SCOMGroup cmdlet.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Path<String>
Specifies the path and file name for the exported .csv file. This cmdlet does not add a file name extension.
Aliases |
none |
Required? |
true |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-RecurseContainedObjects
Indicates that the cmdlet exports data for objects included in the monitoring object that the Instance parameter specifies. For instance, in the case of a computer, the cmdlet exports all discoveries and monitors on the computer and all monitoring objects hosted on the computer, such as disks or network cards.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SCSession<Connection[]>
Specifies an array of Connection objects. To obtain a Connection object, use the Get-SCOMManagementGroupConnection cmdlet.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Export monitoring configuration for a group of computers
This example exports the monitoring configuration for all the computers in a specified group of computers.
The first command gets the group members of the All Windows Computers group and stores the objects in the $Members variable.
The second command uses the pipeline operator to pass each object stored in the $Members variable to the ForEach-Object cmdlet, which includes the Export-SCOMEffectiveMonitoringConfiguration command that exports the data to a .csv file in the specified location. The command includes the name of the computer in the file name, and appends a .csv extension. For more information about ForEach-Object, type Get-Help ForEach-Object.
PS C:\> $Members = (Get-SCOMGroup –DisplayName "All Windows Computers").GetRelatedMonitoringObjects()
PS C:\> $Members | ForEach-Object { Export-SCOMEffectiveMonitoringConfiguration –Instance $_ -Path "C:\temp\$($_.DisplayName).csv" } –RecurseContainedObjects }