Remove-AMObject

NAME Remove-AMObject



SYNOPSIS

Removes an AutoMate Enterprise object.





SYNTAX

Remove-AMObject [[-InputObject] <Object>] [-SkipUsageCheck] [-WhatIf] [-Confirm] [<CommonParameters>]





DESCRIPTION

Remove-AMObject receives AutoMate Enterprise object(s) on the pipeline, or via the parameter $InputObject, and

deletes the object(s).





PARAMETERS

-InputObject <Object>

The object(s) to be deleted.



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-SkipUsageCheck [<SwitchParameter>]

Skips checking if object is in use.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Confirm [<SwitchParameter>]



Required? false

Position? named

Default value

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

The following objects can be removed by this function:

Folder

Workflow

Task

Condition

Process

TaskAgent

ProcessAgent

AgentGroup

User

UserGroup





OUTPUTS

None





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



PS C:\\># Deletes agent "agent01"



Get-AMAgent "agent01" | Remove-AMObject











RELATED LINKS

https://github.com/AutomatePS/AutomatePS