Remove-SCXAgent

Remove-SCXAgent

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

Syntax

Parameter Set: Default
Remove-SCXAgent [-Agent] <IPersistedUnixComputer[]> [-ComputerName <String[]> ] [-Credential <PSCredential> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: Empty
Remove-SCXAgent [-SCSession <Connection[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: FromAgentNames
Remove-SCXAgent [-SCSession <Connection[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: FromManagementServer
Remove-SCXAgent [-SCSession <Connection[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed 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, type Get-Help Get-SCXAgent.

This cmdlet does not return any output.

Parameters

-Agent<IPersistedUnixComputer[]>

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.

Aliases	none
Required?	true
Position?	1
Default Value	none
Accept Pipeline Input?	true (ByValue)
Accept Wildcard Characters?	false

-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 (FQDN). 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 the one that is 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

-SCSession<Connection[]>

Specifies a 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 running the cmdlet.

Required?	false
Position?	named
Default Value	false
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-WhatIf

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

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

• None.

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

Examples

-------------------------- EXAMPLE 1 --------------------------

Description

-----------

This command gets managed UNIX and Linux computers with names matching the provided input, and removes them from management.

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

-------------------------- EXAMPLE 2 --------------------------

Description

-----------

This command gets managed UNIX and Linux computers with names matching provided input, and removes them from management by using a pipeline operation.

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