Share via

Remove-SCXAgent

  • Reference
Module:
OperationsManager

Removes the targeted managed UNIX and Linux computers from the management group.

Syntax

Remove-SCXAgent
      -Agent <IPersistedUnixComputer[]>
      [-SCSession <Connection[]>]
      [-ComputerName <String[]>]
      [-Credential <PSCredential>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-SCXAgent cmdlet removes the targeted managed UNIX and Linux computers from the management group. Managed UNIX and Linux computers are passed to the Remove-SCXAgent cmdlet as an array of UNIX and Linux computer objects.

For information about retrieving managed UNIX and Linux computers, see the Get-SCXAgent cmdlet.

This cmdlet does not return any output.

Examples

Example 1: Remove management agents

PS C:\>$Agents = Get-SCXAgent -Name "scxserver1.contoso.com","scxserver2*","*.development.contoso.com"
PS C:\> Remove-SCXAgent -Agent $Agents

The first command gets agents for managed Linux or UNIX computers that match the specified names by using the Get-SCXAgent cmdlet. The command stores the results in the $Agents array variable.

The final command removes the agents in $Agents.

Example 2: Uninstall a management agent with the defined Run As account

PS C:\>Get-SCXAgent -Name "scxserver1.contoso.com","scxserver2*","*.development.contoso.com" | Remove-SCXAgent

This command gets agents for managed Linux or UNIX computer that match the specified names by using Get-SCXAgent. The command passes the agents to the current cmdlet. The command removes the management agents.

Parameters

-Agent

Specifies one or more managed UNIX and Linux computer objects. For information about how to get a managed UNIX or Linux computer object, type Get-Help Get-SCXAgent.

Type:IPersistedUnixComputer[]
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ComputerName

Specifies an array of names of computers. The cmdlet establishes temporary connections with management groups for these 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 active 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
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Specifies the user account under which the management group connection runs. Specify a PSCredential object, such as one that the Get-Credential cmdlet returns, for this parameter. For more information about credential objects, 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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SCSession

Specifies an array of Connection objects. To get Connection objects, use the Get-SCOMManagementGroupConnection cmdlet.

If this parameter is not specified, the cmdlet uses the active persistent connection to a management group. Use the SCSession parameter to specify a different persistent connection. You can create a temporary connection to a management group by using the ComputerName and Credential parameters. For more information, type Get-Help about_OpsMgr_Connections.

Type:Connection[]
Position:Named
Default value:None
Required:False
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

This cmdlet does not generate any output. There is no failure case for the Remove-SCXAgent cmdlet.