Remove-SCOMADAgentAssignment
Remove-SCOMADAgentAssignment
Removes AD DS agent assignments from the management group.
Syntax
Parameter Set: FromAgentAssignment
Remove-SCOMADAgentAssignment -AgentAssignment <AgentAssignment> -PrimaryServer <ManagementServer> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Remove-SCOMADAgentAssignment cmdlet removes Active Directory Domain Services (AD DS) agent assignments from the management group.
After you remove an agent assignment, the agent managed computers are not monitored by the management group. The state of these computers changes to critical, because the computers no longer send heartbeats to the management group. You can remove these computers from the management group and, if the computer is not assigned to other management groups, you can uninstall the System Center 2012 – Operations Manager agent.
Parameters
-AgentAssignment<AgentAssignment>
Specifies an AgentAssignment object. To obtain an AgentAssignment object, use the Get-SCOMADAgentAssignment cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-ComputerName<String[]>
Specifies an array of names of 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 (.).
You must run the System Center Data Access service before you use this cmdlet. 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 |
-PrimaryServer<ManagementServer>
Specifies a ManagementServer object. This parameter specifies the primary management server for the target agent-managed computers. To obtain a ManagementServer object, use the Get-SCOMManagementServer cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SCSession<Connection[]>
Specifies an array of Connection objects. To obtain a Connection object, use the Get-SCOMManagementGroupConnection cmdlet.
A connection object represents a connection to a management server. The default is the current management group connection.
Aliases |
none |
Required? |
false |
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 an agent assignment by using the primary server
This command removes all AD DS agent assignments for a primary management server. The command uses the Get-SCOMManagementServer cmdlet to get the management server named OMServer01, and passes the result to the Get-SCOMADAgentAssignment cmdlet by using the pipeline operator.
The command gets all AD DS agent assignments that have the primary server named OMServer01, and passes the results to the Remove-SCOMADAgentAssignment cmdlet by using the pipeline operator. The command removes the agent assignments that have the primary server named OMServer01.
PS C:\> Get-SCOMManagementServer "OMServer01*" | Get-SCOMADAgentAssignment | Remove-SCOMADAgentAssignment
Example 2: Remove an agent assignment by using the domain
This command gets all AD DS agent assignments for a domain. The command uses the Get-SCOMADAgentAssignment cmdlet to get the AD DS agent assignment named contoso.com, and passes the result to the Remove-SCOMADAgentAssignment cmdlet by using the pipeline operator. The command cmdlet removes the AD DS agent assignments for the domain named contoso.com.
PS C:\> Get-SCOMADAgentAssignment -Domain "contoso.com" | Remove-SCOMADAgentAssignment