Export (0) Print
Expand All
Expand Minimize

Update-SCOMADAgentAssignment

Updated: January 26, 2014

Applies To: System Center 2012 R2 Operations Manager

Update-SCOMADAgentAssignment

Changes settings of an AD DS agent assignment.

Syntax

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




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

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

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.


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

-Exclude<String[]>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-LdapQuery<String>

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.


Aliases

none

Required?

false

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

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 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: Change the LDAP query for an agent assignment

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.


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

Related topics

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft