Remove-LinaAgent

NAME Remove-LinaAgent



SYNOPSIS

Deletes a Lina Agent from a Lina Server.





SYNTAX

Remove-LinaAgent -Name <String> [-WhatIf] [-Bulk] [<CommonParameters>]



Remove-LinaAgent -LinaAgents <PSObject[]> [-WhatIf] [-Bulk] [<CommonParameters>]





DESCRIPTION

Deletes a Lina Agent. Unique data will be reclaimed automatically by server after some time (configurable).





PARAMETERS

-LinaAgents <PSObject[]>



Required? true

Position? named

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-Name <String>

Name of the agent to delete. Wildcards are accepted (don't forget to enable Bulk mode for actions on multiple

agents).



Required? true

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

No actual deletion will happen if set. It will only display what agents would be deleted.

Sometimes also called "Dry Run mode"



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Bulk [<SwitchParameter>]

Security parameter to enable deletion of multiple agents. If not set only one agent will be deleted.



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, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS

Accept pipelining of LinaAgent objects (from Get-LinaAgent for example)





OUTPUTS

None





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



PS C:\\>Remove-LinaAgent -Name "AGENT132"



Real deletion of a single agent by name









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



PS C:\\>Get-LinaAgent -Name "AGENT132" | Remove-LinaAgent



Same example as #1 but using piped commands









-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Get-LinaAgent -Name "AGENT1*" | Remove-LinaAgent -Bulk -WhatIf



Simulates deletion of a multiple agents by name (WhatIf mode)









-------------------------- EXAMPLE 4 --------------------------



PS C:\\>Get-LinaAgent -Name "AGENT1*" | Remove-LinaAgent -Bulk



Real deletion of a multiple agents by name









-------------------------- EXAMPLE 5 --------------------------



PS C:\\>Get-LinaAgent -ID 164 | Remove-LinaAgent -WhatIf



Simulates deletion of a single agent by ID











RELATED LINKS