Page History
Name
Get-JS7Calendar
SYNOPSIS
Returns calendars from the JOC Cockpit inventory
SYNTAX
Get-JS7Calendar [[-CalendarPath] <String>] [[-Folder] <String>] [-Recursive] [[-RegularExpression] <String>] [-Compact] [-WorkingDays] [-NonWorkingDays] [<CommonParameters>]
DESCRIPTION
Calendars are selected from the JOC Cockpit inventory
* by path and name of a calendar,
* by the folder of the calendar location including sub-folders,
* by a regular expression that is used to filter calendar names.
Resulting calendars can be forwarded to other cmdlets for pipelined bulk operations.
The following REST Web Service API resources are used:
* /calendars
PARAMETERS
CalendarPath
-CalendarPath <String>
Optionally specifies the path and name of a calendar that should be returned.
One of the parameters -Folder, -CalendarPath or -RegularExpression has to be specified if no pipelined calendar objects are provided.
| Required? | false |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByValue, ByPropertyName) |
| Accept wildcard characters? | false |
Folder
-Folder <String>
Optionally specifies the folder for which calendars should be returned.
One of the parameters -Folder, -CalendarPath or -RegularExpression has to be specified if no pipelined calendar objects are provided.
| Required? | false |
| Position? | 2 |
| Default value | / |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Recursive
-Recursive <SwitchParameter>
Specifies that all sub-folders should be looked up if the -Folder parameter is used.
By default no sub-folders will be searched for calendars.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | false |
| Accept wildcard characters? | false |
RegularExpression
-RegularExpression <String>
Specifies that a regular expession is applied to the calendar name to filter results.
| Required? | false |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Compact
-Compact <SwitchParameter>
Specifies that fewer attributes of calendars are returned.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
WorkingDays
-WorkingDays <SwitchParameter>
Specifies that only calendars for working days should be returned.
Such calendars specify days for which orders should be executed with a JS7 Controller.
Only one of the parameters -WorkingDays or -NonWorkingDays can be used.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
NonWorkingDays
-NonWorkingDays <SwitchParameter>
Specifies that only calendars for non-working days should be returned.
Such calendars specify days for which no orders should be executed with a JS7 Controller.
Only one of the parameters -WorkingDays or -NonWorkingDays can be used.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > $calendars = Get-JS7Calendar
Returns all calendars available with the JOC Cockpit inventory.
-------------------------- EXAMPLE 2 --------------------------
PS > $calendars = Get-JS7Calendar -Folder /some_folder -Recursive
Returns all calendars that are configured with the folder "/some_folder" including any sub-folders.
-------------------------- EXAMPLE 3 --------------------------
PS > $calendar = Get-JS7Calendar -CalendarPath /BusinessDays
Returns the calendar that is stored with the path "/BusinessDays".
-------------------------- EXAMPLE 4 --------------------------
PS > $calendars = Get-JS7Calendar -WorkingDays
Returns the calendars that define working days only.
Overview
Content Tools