Remove-SCOMTierConnector
Remove-SCOMTierConnector
Removes a connector from a tiered management group.
Syntax
Parameter Set: Default
Remove-SCOMTierConnector -Connector <MonitoringConnector> -Tier <TieredManagementGroup> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-SCOMTierConnector cmdlet removes a connector from a tiered management group. A tiered management group is part of a connected management group that has peer-to-peer connections between its members and that shares data in a single System Center 2012 – Operations Manager console. Connectors communicate monitoring information between systems in a tiered management group. Removing a connector from a tier stops the tier from transmitting monitoring information to the connector.
Parameters
-ComputerName<String[]>
Specifies an array that contains the name of the computer with which to establish a connection. Valid formats include a NetBIOS name, an IP address, or a fully qualified domain name (FQDN). To specify the local computer, specify the computer name, localhost, or a dot (.).
You must run the System Center Data Access service before you run this cmdlet.
If you do not specify this parameter, the default value is the computer for the current management group connection.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Connector<MonitoringConnector>
Specifies the connector that this cmdlet removes.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies the user account under which the management group connection runs. Specify a PSCredential object, such as one that the Get-Credential cmdlet returns, for this parameter. For more information about credential objects, 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 value is the current user.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SCSession<Connection[]>
Specifies an array of management group connection objects that contains a connection to a management server. To get management group connection objects, specify the Get-SCOMManagementGroupConnection cmdlet. If you do not specify a value for this parameter, the default value is the current management group connection.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Tier<TieredManagementGroup>
Specifies the tiered management group from which to remove the connector. To obtain a tiered management group object, use the Get-SCOMTieredManagementGroup cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
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: Remove connectors from a management group
This example clears all connectors from a tiered management group.
The first command uses the Get-SCOMTieredManagementGroup cmdlet to get tiered management groups from the server, and passes them to the Select-Object cmdlet by using the pipeline operator. The Select-Object cmdlet selects the first tiered management group object, and stores that object in the $Tier variable. For more information, type Get-Help Select-Object.
The second command gets the connectors from the tiered management group in the $Tier variable. It then passes these connectors to the Remove-SCOMTierConnector cmdlet by using the pipeline operator. The cmdlet removes the connectors from the tiered management group in $Tier.
PS C:\> $Tier = Get-SCOMTieredManagementGroup | Select-Object -First 1
PS C:\> Get-SCOMTierConnector -Tier $Tier | Remove-SCOMTierConnector -Tier $Tier
Related topics
Get-SCOMManagementGroupConnection