Get-SCOMADAgentAssignment
Get-SCOMADAgentAssignment
Gets AD DS agent assignments for the management group.
Syntax
Parameter Set: FromDomain
Get-SCOMADAgentAssignment [[-Domain] <String[]> ] [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]
Parameter Set: FromManagementServer
Get-SCOMADAgentAssignment [[-Domain] <String[]> ] -PrimaryServer <ManagementServer[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-SCSession <Connection[]> ] [ <CommonParameters>]
Detailed Description
The Get-SCOMADAgentAssignment cmdlet gets Active Directory Domain Services (AD DS) agent assignments for the management group.
Parameters
-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 |
-Domain<String[]>
Specifies the name of the domain or domain controller in which the target agents reside.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PrimaryServer<ManagementServer[]>
Specifies an array of ManagementServer objects. This parameter specifies the primary management servers for the target agent-managed computer. To obtain a ManagementServer object, use the Get-SCOMManagementServer cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
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 |
<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: Get AD DS agent assignments by using a domain name
This command gets all AD DS agent assignments for the domain named cdomain01.contoso.com.
PS C:\> Get-SCOMADAgentAssignment -Domain "cdomain01.contoso.com"
Example 2: Get AD DS agent assignments by using a primary server
This command gets AD DS agent assignments for a domain that have the same 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 cmdlet gets all AD DS agent assignments for the domain named contoso.com that have the primary server named OMServer01.
PS C:\> Get-SCOMManagementServer "OMServer01*" | Get-SCOMADAgentAssignment -Domain "contoso.com"