Update-SCOMADAgentAssignment

Changes settings of an AD DS agent assignment.

Syntax

Update-SCOMADAgentAssignment
      -AgentAssignment <AgentAssignment>
      -PrimaryServer <ManagementServer>
      [[-LdapQuery] <String>]
      [-Exclude <String[]>]
      [-PassThru]
      [-SCSession <Connection[]>]
      [-ComputerName <String[]>]
      [-Credential <PSCredential>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Update-SCOMADAgentAssignment cmdlet changes settings of an Active Directory Domain Services (AD DS) agent assignment. You can use this cmdlet to change the LDAP query and exclusion list settings of the agent assignment. To change other settings of the agent assignment, remove the agent assignment and re-create it.

Examples

Example 1: Change the LDAP query for an agent assignment

PS C:\>Get-SCOMADAgentAssignment -Domain "contoso.com" | Update-SCOMADAgentAssignment -LdapQuery "(&(sAMAccountType=805306369)(name=SQLSERVER*))"

This command gets the AD DS agent assignment 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 Update-SCOMADAgentAssignment cmdlet by using the pipeline operator. The command changes the LDAP query of the agent assignment for the domain named contoso.com to return only computers with names that match SQLSERVER.

Required Parameters

-AgentAssignment

Specifies an AgentAssignment object. To obtain an AgentAssignment object, use the Get-SCOMADAgentAssignment cmdlet.

Type:AgentAssignment
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters: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.

Type:ManagementServer
Position:Named
Default value:None
Accept pipeline input:True (ByPropertyName)
Accept wildcard characters:False

Optional Parameters

-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.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:PSCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Exclude

Specifies an array of names of computers. Operations Manager excludes the computers that you specify from the agent assignment. Operations Manager excludes these computers even if the LDAP query returns the computers.

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-LdapQuery

Specifies the LDAP query in the domain which selects the target agent computers. If you do not specify this parameter, the cmdlet uses the current LDAP query.

Type:String
Position:3
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

Indicates that the cmdlet creates or modifies an object that a command can use in the pipeline. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters: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.

Type:Connection[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False