< Back
Find-AMObject
Post
NAME Find-AMObject
SYNOPSIS
Finds objects in AutoMate Enterprise.
SYNTAX
Find-AMObject [-Pattern] <String> [-Regex] [-Type <String[]>] [-SearchDepth <Int32>] [-Connection <Object>]
[<CommonParameters>]
DESCRIPTION
Find-AMObject searches AutoMate Enterprise for objects based on a search query.
PARAMETERS
-Pattern <String>
The pattern to use when searching. Regular expressions are supported.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Regex [<SwitchParameter>]
Specify if the -Pattern parameter is a regular expression. Otherwise, normal wildcards are used.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Type <String[]>
The object type(s) to perform search against.
Required? false
Position? named
Default value @("Workflow","Task","Condition","Process","Agent","AgentGroup","User","UserGroup")
Accept pipeline input? false
Accept wildcard characters? false
-SearchDepth <Int32>
The number of layers (sub-objects/properties) in every object to search. Using a search depth that is too
deep can significantly increase search time.
Required? false
Position? named
Default value 3
Accept pipeline input? false
Accept wildcard characters? false
-Connection <Object>
The server to perform search against.
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
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\># Find all tasks that have FTP activities
Find-AMObject -Pattern "AMFTP" -Type Task
RELATED LINKS
https://github.com/AutomatePS/AutomatePS
SYNOPSIS
Finds objects in AutoMate Enterprise.
SYNTAX
Find-AMObject [-Pattern] <String> [-Regex] [-Type <String[]>] [-SearchDepth <Int32>] [-Connection <Object>]
[<CommonParameters>]
DESCRIPTION
Find-AMObject searches AutoMate Enterprise for objects based on a search query.
PARAMETERS
-Pattern <String>
The pattern to use when searching. Regular expressions are supported.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Regex [<SwitchParameter>]
Specify if the -Pattern parameter is a regular expression. Otherwise, normal wildcards are used.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-Type <String[]>
The object type(s) to perform search against.
Required? false
Position? named
Default value @("Workflow","Task","Condition","Process","Agent","AgentGroup","User","UserGroup")
Accept pipeline input? false
Accept wildcard characters? false
-SearchDepth <Int32>
The number of layers (sub-objects/properties) in every object to search. Using a search depth that is too
deep can significantly increase search time.
Required? false
Position? named
Default value 3
Accept pipeline input? false
Accept wildcard characters? false
-Connection <Object>
The server to perform search against.
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
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\># Find all tasks that have FTP activities
Find-AMObject -Pattern "AMFTP" -Type Task
RELATED LINKS
https://github.com/AutomatePS/AutomatePS