Page History
Name
Get-JS7ReleasableItem
SYNOPSIS
Returns releasable configuration objects such as schedules from the JOC Cockpit inventory.
SYNTAX
Get-JS7ReleasableItem [[-Path] <String>] [[-Type] <String[]>] [[-Folder] <String>] [-Recursive] [<CommonParameters>]
DESCRIPTION
This cmdlet returns releasable configuration objects from the JOC Cockpit inventory.
PARAMETERS
Path
-Path <String>
Specifies the folder, sub-folder and name of the object, e.g. a schedule path.
Required? | false |
Position? | 1 |
Default value | |
Accept pipeline input? | true (ByValue, ByPropertyName) |
Accept wildcard characters? | false |
Type
-Type <String[]>
Specifies the object type which is one of:
* SCHEDULE
* WORKINGDAYSCALENDAR
* NONWORKINGDAYSCALENDAR
Required? | false |
Position? | 2 |
Default value | |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Folder
-Folder <String>
Optionally specifies the folder for which included inventory objects should be returned.
This parameter is used alternatively to the -Path parameter that specifies to return an individual inventory object.
Required? | false |
Position? | 3 |
Default value | / |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
Recursive
-Recursive <SwitchParameter>
Specifies that any sub-folders should be looked up. By default no sub-folders will be considered.
Required? | false |
Position? | named |
Default value | False |
Accept pipeline input? | true (ByPropertyName) |
Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Get-JS7ReleasableItem -Path /TestCases/sampleSchedule001 -Type 'SCHEDULE'
Returns the specified schedule with the indicated path.
-------------------------- EXAMPLE 2 --------------------------
PS > Get-JS7ReleasableItem -Folder /TestCases -Recursive -Type 'FOLDER'
Returns releasable objects from a folder and any sub-folders.