JS7 JobScheduler

Space shortcuts

Page tree

Name

Get-JS7Lock

SYNOPSIS

Returns Locks from the JOC Cockpit inventory

SYNTAX

Get-JS7Lock [[-LockPath] <String>] [[-Folder] <String>] [-Recursive] [<CommonParameters>]

DESCRIPTION

Locks are returned from JOC Cockpit that have been deployed to the current Controller instances.
Locks can be selected either by the folder of the lock location including sub-folders or by an individual lock path.

Resulting locks can be forwarded to other cmdlets for pipelined bulk operations.

The following REST Web Service API resources are used:

* /locks

PARAMETERS

LockPath

-LockPath <String>
Optionally specifies the path and name of a lock that should be returned.

One of the parameters -Folder or -LockPath has to be specified.

Required?false
Position?1
Default value
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

Folder

-Folder <String>
Optionally specifies the folder for which locks should be returned.

One of the parameters -Folder or -LockPath has to be specified.

Required?false
Position?2
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 searched for locks.

Required?false
Position?named
Default valueFalse
Accept pipeline input?true (ByPropertyName)
Accept wildcard characters?false

about_JS7

EXAMPLES

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

PS > $locks = Get-JS7Lock

Returns all deployed locks.

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

PS > $locks = Get-JS7Lock -Folder /some_folder -Recursive

Returns all locks that are configured with the specified folder including any sub-folders.

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

PS > $locks = Get-JS7Lock -LockPath /test/globals/lock1

Returns the lock "lock1" from the folder "/test/globals".

  • No labels