Remove-SCOMADAgentAssignment
Removes AD DS agent assignments from the management group.
Syntax
Default (Default)
Remove-SCOMADAgentAssignment
-AgentAssignment <AgentAssignment>
-PrimaryServer <ManagementServer>
[-SCSession <Connection[]>]
[-ComputerName <String[]>]
[-Credential <PSCredential>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
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 2016 - Operations Manager agent.
Examples
Example 1: Remove an agent assignment by using the primary server
PS C:\>Get-SCOMManagementServer "OMServer01*" | Get-SCOMADAgentAssignment | Remove-SCOMADAgentAssignment
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.
Example 2: Remove an agent assignment by using the domain
PS C:\>Get-SCOMADAgentAssignment -Domain "contoso.com" | Remove-SCOMADAgentAssignment
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.
Parameters
-AgentAssignment
Specifies an AgentAssignment object. To obtain an AgentAssignment object, use the Get-SCOMADAgentAssignment cmdlet.
Parameter properties
| Type: | AgentAssignment |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ComputerName
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 (.).
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.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Credential
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.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PrimaryServer
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.
Parameter properties
| Type: | ManagementServer |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-SCSession
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.
Parameter properties
| Type: | Connection[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.