Get-AMCalendar

NAME Get-AMCalendar



SYNOPSIS

Gets AutoMate Enterprise calendar events.





SYNTAX

Get-AMCalendar [-StartDate <DateTime>] [-EndDate <DateTime>] [-Type <String>] [-FilterSet <Hashtable[]>]

[-FilterSetMode <String>] [-SortProperty <String[]>] [-SortDescending] [-Connection <Object>] [<CommonParameters>]



Get-AMCalendar [[-InputObject] <Object>] [-StartDate <DateTime>] [-EndDate <DateTime>] [-Type <String>]

[-FilterSet <Hashtable[]>] [-FilterSetMode <String>] [-SortProperty <String[]>] [-SortDescending] [-Connection

<Object>] [<CommonParameters>]





DESCRIPTION

Get-AMCalendar gets events from the calendar.





PARAMETERS

-InputObject <Object>

The object(s) to search the calendar for.



Required? false

Position? 1

Default value

Accept pipeline input? true (ByValue)

Accept wildcard characters? false



-StartDate <DateTime>

The first date of events to retrieve (Default: now - must be equal or greater than the current time).



Required? false

Position? named

Default value (Get-Date)

Accept pipeline input? false

Accept wildcard characters? false



-EndDate <DateTime>

The last date of events to retrieve (Default: 24 hours from now).



Required? false

Position? named

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

Accept pipeline input? false

Accept wildcard characters? false



-Type <String>

The schedule types to retrieve:

Specific - The schedule defines specific dates and times.

Weekly - The schedule reoccurs on a weekly basis.

Monthly - The schedule reoccurs on a monthly basis.

Holidays - The schedule occurs on a holiday.

Non-Interval - ???



Required? false

Position? named

Default value

Accept pipeline input? false

Accept wildcard characters? false



-FilterSet <Hashtable[]>

The parameters to filter the search on. Supply hashtable(s) with the following properties: Property,

Operator, Value.

Valid values for the Operator are: =, !=, <, >, contains (default - no need to supply Operator when using

'contains')



Required? false

Position? named

Default value @()

Accept pipeline input? false

Accept wildcard characters? false



-FilterSetMode <String>

If multiple filter sets are provided, FilterSetMode determines if the filter sets should be evaluated with an

AND or an OR



Required? false

Position? named

Default value And

Accept pipeline input? false

Accept wildcard characters? false



-SortProperty <String[]>

The object property to sort results on. Do not use ConnectionAlias, since it is a custom property added by

this module, and not exposed in the API.



Required? false

Position? named

Default value NextRunTime

Accept pipeline input? false

Accept wildcard characters? false



-SortDescending [<SwitchParameter>]

If specified, this will sort the output on the specified SortProperty in descending order. Otherwise,

ascending order is assumed.



Required? false

Position? named

Default value False

Accept pipeline input? false

Accept wildcard characters? false



-Connection <Object>

The AutoMate Enterprise management server.



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

Calendar events related to the following objects can be retrieved by this function:

Workflow

Condition

Folder





OUTPUTS

Calendar





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



PS C:\\># Get calendar events for the next 7 days



Get-AMCalendar -EndDate (Get-Date).AddDays(7)









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



PS C:\\># Get calendar events for workflow "My Workflow"



Get-AMWorkflow "My Workflow" | Get-AMCalendar









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



PS C:\\># Get calendar events using filter sets



Get-AMCalendar -FilterSet @{Property = 'ScheduleDescription'; Operator = 'contains'; Value = 'hour(s)'}











RELATED LINKS

https://github.com/AutomatePS/AutomatePS