Page History
Name
Invoke-JS7GitRepositoryCheckout
SYNOPSIS
Performs a checkout from a remote Git repository to a local repository
SYNTAX
Invoke-JS7GitRepositoryCheckout [-Folder] <String> [-Local] [[-Branch] <String>] [[-Tag] <String>] [[-AuditComment] <String>] [[-AuditTimeSpent] <Int32>] [[-AuditTicketLink] <Uri>] [<CommonParameters>]
DESCRIPTION
This cmdlet performs a checkout from a remote Git repository to the local repository.
This includes to overwrite any objects in the local repository.
A local directory located in JETTY_BASE/resources/joc/repositories/rollout/TestCases
is mapped to a JOC Cockpit /TestCases inventory folder.
This cmdlet corresponds to using the following Git command:
* git checkout <branch> <tag>
The following REST Web Service API resources are used:
* /inventory/repository/git/checkout
PARAMETERS
Folder
-Folder <String>
Specifies the JOC Cockpit inventory folder that maps to the Git repository.
| Required? | true |
| Position? | 1 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Local
-Local <SwitchParameter>
Specifies that a repository holding scheduling objects that are local to the environment should be used.
This corresponds to the LOCAL category. If this switch is not used then the
ROLLOUT category is assumed for a repository that holds scheduling objects
intended for rollout to later environments such as test, prod.
| Required? | false |
| Position? | named |
| Default value | False |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Branch
-Branch <String>
Specifies the name of the branch in the remote Git repository.
| Required? | false |
| Position? | 2 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
Tag
-Tag <String>
Specifies the name of the tag in the remote Git repository.
| Required? | false |
| Position? | 3 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditComment
-AuditComment <String>
Specifies a free text that indicates the reason for the current intervention, e.g. "business requirement", "maintenance window" etc.
The Audit Comment is visible from the Audit Log view of JOC Cockpit.
This parameter is not mandatory, however, JOC Cockpit can be configured to enforce Audit Log comments for any interventions.
| Required? | false |
| Position? | 4 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditTimeSpent
-AuditTimeSpent <Int32>
Specifies the duration in minutes that the current intervention required.
This information is visible with the Audit Log view. It can be useful when integrated
with a ticket system that logs the time spent on interventions with JobScheduler.
| Required? | false |
| Position? | 5 |
| Default value | 0 |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
AuditTicketLink
-AuditTicketLink <Uri>
Specifies a URL to a ticket system that keeps track of any interventions performed for JobScheduler.
This information is visible with the Audit Log view of JOC Cockpit.
It can be useful when integrated with a ticket system that logs interventions with JobScheduler.
| Required? | false |
| Position? | 6 |
| Default value | |
| Accept pipeline input? | true (ByPropertyName) |
| Accept wildcard characters? | false |
RELATED LINKS
EXAMPLES
-------------------------- EXAMPLE 1 --------------------------
PS > Invoke-JS7GitRepositoryCheckout -Folder /TestCases -Branch "v1.12"
Updates the local repository that maps to the JOC Cockpit /TestCases inventory folder from branch "v1.12" in the remote Git repository.
Overview
Content Tools