Get-SCXAgent
Applies To: System Center 2012 - Operations Manager, System Center 2012 R2 Operations Manager, System Center 2012 SP1 - Operations Manager
Get-SCXAgent
Gets a list of managed UNIX and Linux computers in a management group.
Syntax
Parameter Set: Empty
Get-SCXAgent [-SCSession <Connection[]> ] [ <CommonParameters>]
Parameter Set: FromAgentGuidsParameterSetName
Get-SCXAgent [-ID] <Guid[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [ <CommonParameters>]
Parameter Set: FromAgentNamesParameterSetName
Get-SCXAgent [-Name] <String[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [ <CommonParameters>]
Parameter Set: FromHostNameAndResourcePoolParameterSetName
Get-SCXAgent -ResourcePool <ManagementServicePool> [ <CommonParameters>]
Parameter Set: FromIPRangeAndResourcePoolParameterSetName
Get-SCXAgent -ResourcePool <ManagementServicePool> [ <CommonParameters>]
Parameter Set: FromManagementServerParameterSetName
Get-SCXAgent [-ComputerName <String[]> ] [-Credential <PSCredential> ] [ <CommonParameters>]
Detailed Description
The Get-SCXAgent cmdlet retrieves the managed UNIX and Linux computers that match the provided selection criteria. If no selection criteria are specified, all managed UNIX and Linux computers in the management group are returned.
Results are returned as an array of managed UNIX and Linux computer objects.
Parameters
-ComputerName<String[]>
Specifies the name of a computer to establish a connection with. The computer must be running the System Center Data Access Service. The default value is the computer for the current management group connection. Valid formats include a NetBIOS name, an IP address, or a fully qualified domain name. To specify the local computer, type the computer name, "localhost", or a dot (.).
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies a user account under which the management group connection will run. The default is the current user. Type a user name, such as "User01", "Domain01\User01", or "User@Domain.com", or enter a PSCredential object, such as one returned by the Get-Credential cmdlet. When you type a user name, you are prompted for a password. For more information, type Get-Help Get-Credential.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-ID<Guid[]>
Specifies the ID of a managed UNIX or Linux computer object. Returns only the only managed computers with ID properties that match this value. This parameter is accepted from the pipeline.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies a list of fully qualified domain names for one or more managed UNIX and Linux computers. Returns only the managed computers that match the Name property.
You can include wildcards, in which case all computers matching the wildcard are returned. For information about using wildcards, type Get-Help About_Wildcards.
This parameter is accepted from the pipeline.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
true (ByValue) |
Accept Wildcard Characters? |
false |
-ResourcePool<ManagementServicePool>
Specifies a resource pool of servers, one of which is assigned to be the current management server and the other serving as backup management servers. This parameter requires a resource pool object and returns only the managed computers in that resource pool.
For information about how to get a SCOMResourcePool object, type Get-Help Get-SCOMResourcePool.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SCSession<Connection[]>
Specifies a management group connection to use instead of the default connection.
For more information, type Get-Help Get-ManagementGroupConnection.
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.
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.
Microsoft.Unix.Computer[]
This cmdlet returns one or more Computer objects that represent managed UNIX and Linux computers when the UNIX and Linux computers match input criteria.
Examples
-------------------------- EXAMPLE 1 --------------------------
Description
-----------
This command returns all managed UNIX and Linux computers in the resource pool.
C:\PS>Get-SCXAgent
-------------------------- EXAMPLE 2 --------------------------
Description
-----------
This command returns all managed UNIX and Linux computers for a specified resource pool.
C:\PS>$myPool = Get-SCOMResourcePool -DisplayName "pool01"
Get-SCXAgent -ResourcePool $myPool
-------------------------- EXAMPLE 3 --------------------------
Description
-----------
This command returns managed UNIX and Linux computers with names that are matching a provided list of strings.
C:\PS>Get-SCXAgent -Name nx1.contoso.com,nx2.*,*.development.contoso.com
-------------------------- EXAMPLE 4 --------------------------
Description
-----------
This command provides the Name parameter through the pipeline.
C:\PS>"server1", "server2", "server3" | Get-SCXAgent
-------------------------- EXAMPLE 5 --------------------------
Description
-----------
This command connects to a resource pool with a temporary connection, by using the current user's credentials, and returns only the managed computers that match the Name property.
C:\PS>Get-SCXAgent -Name *development.contoso.com -ComputerName server1.contoso.com