Get-JenkinsJob

NAME Get-JenkinsJob



SYNOPSIS

Get a Jenkins Job Definition.





SYNTAX

Get-JenkinsJob [-Uri] <String> [[-Credential] <PSCredential>] [[-Crumb] <String>] [[-Folder] <String>] [-Name]

<String> [<CommonParameters>]





DESCRIPTION

Gets the config.xml of a Jenkins job if it exists on the Jenkins Master server. If the job does not exist an error

will occur. If a folder is specified it will find the job in the specified folder.





PARAMETERS

-Uri <String>

Contains the Uri to the Jenkins Master server to get the Job definition from.



Required? true

Position? 2

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Credential <PSCredential>

Contains the credentials to use to authenticate with the Jenkins Master server.



Required? false

Position? 3

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Crumb <String>

Contains a Crumb to pass to the Jenkins Master Server if CSRF is enabled.



Required? false

Position? 4

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Folder <String>

The optional job folder to look for the job in. This requires the Jobs Plugin to be installed on Jenkins.



Required? false

Position? 5

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Name <String>

The name of the job definition to get.



Required? true

Position? 6

Default value None

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



OUTPUTS

A string containing the Jenkins Job config XML.







NOTES









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



PS C:\\>Get-JenkinsJob `

-Uri 'https://jenkins.contoso.com' \\`

-Credential (Get-Credential) \\`

-Name 'My App Build' \\`

-Verbose



Returns the XML config of the 'My App Build' job on https://jenkins.contoso.com using the credentials provided by

the user.

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



PS C:\\>Get-JenkinsJob `

-Uri 'https://jenkins.contoso.com' \\`

-Credential (Get-Credential) \\`

-Folder 'Misc' \\`

-Name 'My App Build' \\`

-Verbose



Returns the XML config of the 'My App Build' job in the 'Misc' folder on https://jenkins.contoso.com using the

credentials provided by the user.

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



Get-JenkinsJob `

-Uri 'https://jenkins.contoso.com' \\`

-Credential (Get-Credential) \\`

-Folder 'Misc/Build' \\`

-Name 'My App Build' \\`

-Verbose



Returns the XML config of the 'My App Build' job in the 'Build' folder in the 'Misc' folder on

https://jenkins.contoso.com using the credentials provided by the user.



RELATED LINKS