Remove-SCAdvisorAgent
Applies To: System Center 2012 R2 Operations Manager
Remove-SCAdvisorAgent
Removes one or more agents from the group of agents that report to the Advisor Connector.
Syntax
Parameter Set: Default
Remove-SCAdvisorAgent [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-InputObjects <PartialMonitoringObject[]> ] [-PipelineVariable <String> ] [-SCSession <Connection[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-SCAdvisorAgent cmdlet removes one or more agents from the group of agents that report to the System Center Advisor Connector.
Parameters
-ComputerName<String[]>
Specifies an array of names of computers to establish connections with. The computer that you connect to must run the System Center Data Access service. The default is the computer for the current management group connection. Valid formats include a NetBIOS name, an IP address, and a fully qualified domain name. To specify the local computer, type the computer name, localhost, or a dot (.).
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
localhost |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies a PSCredential object under which the management group connection runs. To obtain a PSCredential object, use the Get-Credential cmdlet. For more information, type Get-Help Get-Credential.
You can specify a user name in one of the following formats: User01, Domain01\User01, or User@Domain.com. The default is the current user. The cmdlet prompts you for a password.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-InputObjects<PartialMonitoringObject[]>
Specifies an array of computer names to opt out from the Advisor Connector.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-PipelineVariable<String>
Specifies a variable to use with the pipeline operator.
Aliases |
pv |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SCSession<Connection[]>
Specifies an array of connections to a management server. The default is the current management group connection. To obtain a management group connection object, use the Get-SCOMManagementGroupConnection cmdlet.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
the current management group connection |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before executing the command.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Describes what would happen if you executed the command without actually executing the command.
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.
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 agents by name from a group of computers
The first command uses the Get-SCOMClass cmdlet to get all the Windows-based computers, passes those computers to the Get-SCOMClassInstance cmdlet by using the pipeline operator, and then uses the Where-Object cmdlet to find computers that contain the name ContosoAgent. The command stores these instances in the $WindowsComputers variable. For more information, type Get-Help Where-Object.
The second command removes all the agents that are stored in $WindowsComputers from the group of agents that report to the Advisor Connector.
PS C:\> $WindowsComputers = Get-SCOMClass -Name "Microsoft.Windows.computer" | Get-SCOMClassInstance | Where {$_.Name.Contains("ContosoAgent")}
PS C:\> Remove-SCAdvisorAgent -InputObjects $WindowsComputers
Example 2: Remove agents by name from a computer
The first command uses Get-SCOMClass to get all the Windows-based computers, passes those computers to Get-SCOMClassInstance by using the pipeline operator to find Computer062, and then uses Where-Object to find agents that contain the name ContosoAgent. The command stores these instances in the $WindowsComputers variable.
The second command removes all the Windows-based computers that are stored in $WindowsComputers from the group of agents that report to the Advisor Connector.
PS C:\> $WindowsComputers = Get-SCOMClass -Name "Microsoft.Windows.computer" | Get-SCOMClassInstance -ComputerName "Computer062" | Where {$_.Name.Contains("ContosoAgent")}
PS C:\> Remove-SCAdvisorAgent -InputObjects $WindowsComputers -ComputerName "Computer062"