PowerShell module for interacting with a CloudBees Jenkins server using the Jenkins Rest API. Created by IAG NZ Ltd.

If Windows Management Framework 5.0 or above is installed or the PowerShell Package management module is available:

The easiest way to download and install the Jenkins module is using PowerShell Get to download it from the PowerShell Gallery:

Install-Module -Name Jenkins

If Windows Management Framework 5.0 or above is not available and and the PowerShell Package management module is not available:

Unzip the file containing this Module to your c:\Program Files\WindowsPowerShell\Modules folder.

• Get-JenkinsCrumb: Gets a Jenkins Crumb.
• Invoke-JenkinsCommand: Execute a Jenkins command or request via the Jenkins Rest API.
• Get-JenkinsObject: Get a list of objects in a Jenkins master server.
• Get-JenkinsJobList: Get a list of jobs in a Jenkins master server.
• Get-JenkinsJob: Get a Jenkins Job Definition.
• Set-JenkinsJob: Set a Jenkins Job definition.
• Test-JenkinsJob: Determines if a Jenkins Job exists.
• New-JenkinsJob: Create a new Jenkins Job.
• Rename-JenkinsJob: Rename an existing Jenkins Job.
• Remove-JenkinsJob: Remove an existing Jenkins Job.
• Invoke-JenkinsJob: Run a parameterized or non-parameterized Jenkins Job.
• Get-JenkinsViewList: Get a list of views in a Jenkins master server.
• Test-JenkinsView: Determines if a Jenkins View exists.
• Get-JenkinsFolderList: Get a list of folders in a Jenkins master server.
• Test-JenkinsFolder: Determines if a Jenkins Folder exists.
• Initialize-JenkinsUpdateCache: Creates or updates a local Jenkins Update cache.
• Get-JenkinsPluginsList: Retreives a list of installed plugins.
• Invoke-JenkinsJobReload: Reloads a job config on a given URL.

If a Jenkins Server has the CSRF setting enabled, then a "Crumb" will first need to be obtained and passed to each subsequent call to Jenkins in the Crumb parameter. If you receive errors regarding crumbs then your Jenkins Server has CSRF enabled and you will to ensure you are passing a valid "Crumb" obtained by calling the Get-JenkinsCrumb cmdlet.

To work with a Jenkins Master that has CSRF enabled:

$Crumb = Get-JenkinsCrumb `
    -Uri 'https://jenkins.contoso.com' `
    -Credential $Credential

New-JenkinsFolder `
    -Uri 'https://jenkins.contoso.com' `
    -Credential $Credential `
    -Crumb $Crumb `
    -Name 'Management' `
    -Verbose

• Initialize-JenkinsUpdateCache: Does not correctly set the signature information in the update-center.json file that is created.

• If your Jenkins Server has security enabled then you should ensure that you are only connecting to it via HTTPS.
• If your Jenkins Server has security enabled, the Credentials parameter that can accept either the password for the Jenkins account or the API Token. It is strongly recommended that you use the API Token for the account as the password rather than the Jenkins account, even if you have implemented HTTPS.

Import-Module -Name Jenkins
$Crumb = Get-JenkinsCrumb `
    -Uri 'https://jenkins.contoso.com' `
    -Credential $Credential

Import-Module -Name Jenkins
$Jobs = Get-JenkinsJobList `
    -Uri 'https://jenkins.contoso.com' `
    -Credential (Get-Credential)

Import-Module -Name Jenkins
$Jobs = Get-JenkinsJobList `
    -Uri 'https://jenkins.contoso.com' `
    -Credential (Get-Credential) `
    -Folder 'Misc'

Import-Module -Name Jenkins
$Jobs = Get-JenkinsJobList `
    -Uri 'https://jenkins.contoso.com' `
    -Credential (Get-Credential) `
    -IncludeClass 'hudson.model.FreeStyleProject'

Import-Module -Name Jenkins
$Folders = Get-JenkinsFolderList `
    -Uri 'https://jenkins.contoso.com' `
    -Credential (Get-Credential)

Import-Module -Name Jenkins
$MyAppBuildConfig = Get-JenkinsJob `
    -Uri 'https://jenkins.contoso.com' `
    -Credential (Get-Credential) `
    -Name 'My App Build'

Import-Module -Name Jenkins
Set-JenkinsJob `
    -Uri 'https://jenkins.contoso.com' `
    -Credential (Get-Credential) `
    -Name 'My App Build' `
    -XML $MyAppBuildConfig

Import-Module -Name Jenkins
if (Test-JenkinsJob `
        -Uri 'https://jenkins.contoso.com' `
        -Credential (Get-Credential) `
        -Name 'My App Build') {
    # ... Jenkins Job was found
}

Import-Module -Name Jenkins
New-JenkinsJob `
    -Uri 'https://jenkins.contoso.com' `
    -Credential (Get-Credential) `
    -Name 'My App Build' `
    -XML $MyAppBuildConfig

Import-Module -Name Jenkins
Rename-JenkinsJob `
    -Uri 'https://jenkins.contoso.com' `
    -Credential (Get-Credential) `
    -Name 'My App Build'
    -NewName 'Other Build'

Import-Module -Name Jenkins
Remove-JenkinsJob `
    -Uri 'https://jenkins.contoso.com' `
    -Credential (Get-Credential) `
    -Name 'My App Build'

Import-Module -Name Jenkins
Invoke-JenkinsJob `
    -Uri 'https://jenkins.contoso.com' `
    -Credential (Get-Credential) `
    -Name 'My App Build'

Import-Module -Name Jenkins
Invoke-JenkinsJob `
    -Uri 'https://jenkins.contoso.com' `
    -Credential (Get-Credential) `
    -Name 'My App Build' `
    -Parameters @{ verbosity = 'full'; buildtitle = 'test build' }

$Plugins = Get-JenkinsPluginsList `
        -Uri 'https://jenkins.contoso.com' `
        -Credential (Get-Credential) `
        -Verbose

Invoke-JenkinsJobReload `
        -Uri 'https://jenkins.contoso.com' `
        -Credential (Get-Credential) `
        -Verbose
    Triggers a reload of the jenkins server 'https://jenkins.contoso.com'

For further examples, please see module help for individual cmdlets.

• Fixed Invoke-JenkinsJobReload to use invoke-jenkinscommand

• Fix error in New-JenkinsFolder.
• Added Cross Site Request Forgery Support.

• Updated Invoke-JenkinsJobReload to use the -UseBasicParsing switch

• Fixed readme
• Added the Invoke-JenkinsJobReload cmdlet

• Added Get-JenkinsPluginsList cmdlet to retreive a list of installed plugins

• Added Initialize-JenkinsUpdateCache cmdlet to create or update a local Jenkins Update Cache

• Fix bug when pulling Jenkins items from more than 1 folder deep
• Added support for folder to be specified with / or \

• Update AppVeyor deployment process to tag releases

• Added New-JenkinsFolder cmdlet

• Added Invoke-JenkinsJob cmdlet

• Added Examples to Readme.md

• Appveyor build improvements
• Additional unit tests added

• Initial Release containing:
  • Invoke-JenkinsCommand
  • Get-JenkinsObject
  • Get-JenkinsJobList
  • Get-JenkinsJob
  • Set-JenkinsJob
  • Test-JenkinsJob
  • New-JenkinsJob
  • Remove-JenkinsJob
  • Get-JenkinsViewList
  • Test-JenkinsView
  • Get-JenkinsFolderList
  • Test-JenkinsFolder

• IAG NZ Web Site
• IAG NZ GitHub Organization
• Project site on GitHub