Get-AMObject

NAME Get-AMObject



SYNOPSIS

Retrieves any AutoMate Enterprise object by ID.





SYNTAX

Get-AMObject [-ID] <Object> [[-Types] {Undefined | Folder | Task | Workflow | Condition | RootContainer |

UserPreference | Agent | MachineConnection | User | AgentGroup | UserGroup | Evaluation | Comment | AuditEvent |

ExecutionEvent | Connection | Wait | Joiner | Exclusion | ServerProperty | WorkflowProperty | AgentProperty |

TaskProperty | Constant | Package | AMSystem | Permission | SystemPermission | Process | WorkflowItemProperty |

WorkflowItem | WorkflowLink | WorkflowVariable | ExecutionServerProperty | ManagementServerProperty |

ManagedTaskProperty | Snapshot | ExclusionPeriod | SnapshotInfo | Notification | Instance | ApiPermission |

SNMPCredential | WindowsControl | SystemAgent | WorkflowTrigger | WorkflowCondition}] [[-Connection] <Object>]

[<CommonParameters>]





DESCRIPTION

Get-AMObject allows search for any AutoMate Enterprise object by its ID when the construct type is not known.





PARAMETERS

-ID <Object>

The ID to search for.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Types

The construct types to search, all are searched by default.



Required? false

Position? 2

Default value @([AMConstructType]::Workflow, `

[AMConstructType]::Task, `

[AMConstructType]::Process, `

[AMConstructType]::Condition, `

[AMConstructType]::Agent, `

[AMConstructType]::AgentGroup, `

[AMConstructType]::User, `

[AMConstructType]::UserGroup, `

[AMConstructType]::Folder

)

Accept pipeline input? false

Accept wildcard characters? false



-Connection <Object>

The server to search.



Required? false

Position? 3

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:\\>Get-AMObject -ID "{1525ea3b-45cc-4ee1-9b34-8ea855c3b299}"















RELATED LINKS

https://github.com/AutomatePS/AutomatePS