Get-AMMetric

NAME Get-AMMetric



SYNOPSIS

Gets metrics from AutoMate Enterprise.





SYNTAX

Get-AMMetric [[-Type] <Object>] [[-Folder] <Object>] [[-StartDate] <DateTime>] [[-EndDate] <DateTime>]

[[-IntervalSeconds] <Int32>] [[-DeviationPercentage] <Int32>] [[-DeviationDirection] <String>] [[-Connection]

<Object>] [<CommonParameters>]





DESCRIPTION

Get-AMMetric gets metrics from AutoMate Enterprise.





PARAMETERS

-Type <Object>

The type of metrics to query: Running, Completed, Queued, Deviations.



Required? false

Position? 1

Default value Running

Accept pipeline input? false

Accept wildcard characters? false



-Folder <Object>

The folder containing objects to retrieve metrics for.



Required? false

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-StartDate <DateTime>

The first date of metrics to retrieve (Default: 1 day ago).



Required? false

Position? 3

Default value (Get-Date).AddDays(-1)

Accept pipeline input? false

Accept wildcard characters? false



-EndDate <DateTime>

The last date of metrics to retrieve (Default: now).



Required? false

Position? 4

Default value (Get-Date)

Accept pipeline input? false

Accept wildcard characters? false



-IntervalSeconds <Int32>

The interval to use for Running, Queued and Completed metrics.



Required? false

Position? 5

Default value 3600

Accept pipeline input? false

Accept wildcard characters? false



-DeviationPercentage <Int32>

The deviation percentage when querying deviation metrics.



Required? false

Position? 6

Default value 0

Accept pipeline input? false

Accept wildcard characters? false



-DeviationDirection <String>

The deviation direction when querying deviation metrics.



Required? false

Position? 7

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Connection <Object>

The AutoMate Enterprise management server.



Required? false

Position? 8

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

Folder





OUTPUTS

Metrics





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



PS C:\\># Get completed metrics over a 24 hour interval for the past week



Get-AMMetric -Type Completed -Interval 86400 -StartDate (Get-Date).AddDays(-7)











RELATED LINKS

https://github.com/AutomatePS/AutomatePS