Plugin manager usage in Jenkins - Commands & Configuration

Introduction

Jenkins plugins add extra features to your Jenkins server. The plugin manager helps you install, update, and remove these plugins easily to customize your automation.

When you want to add support for a new programming language or tool in Jenkins

When you need to update existing plugins to get new features or security fixes

When you want to remove plugins that are no longer needed to keep Jenkins clean

When setting up a new Jenkins server and need to install essential plugins

When troubleshooting plugin issues by reinstalling or rolling back plugins

Commands

This command lists all installed plugins on the Jenkins server to see what is currently available.

Terminal

java -jar jenkins-cli.jar -s http://localhost:8080 list-plugins

Expected Output

ace-editor 1.1

ansicolor 0.6.2

git 4.10.0

workflow-aggregator 2.6

This command installs the 'git' and 'workflow-aggregator' plugins and restarts Jenkins to apply changes.

Terminal

java -jar jenkins-cli.jar -s http://localhost:8080 install-plugin git workflow-aggregator -restart

Expected Output

Installing git from updates.jenkins.io

Installing workflow-aggregator from updates.jenkins.io

Restarting Jenkins to apply changes...

→

-restart - Restarts Jenkins automatically after plugin installation

This command removes the 'ansicolor' plugin from Jenkins to clean up unused plugins.

Terminal

java -jar jenkins-cli.jar -s http://localhost:8080 uninstall-plugin ansicolor

Expected Output

Uninstalling ansicolor

Plugin ansicolor will be removed after next restart.

This command safely restarts Jenkins to complete plugin installation or removal without interrupting running jobs.

Terminal

java -jar jenkins-cli.jar -s http://localhost:8080 safe-restart

Expected Output

Jenkins is restarting safely...

Key Concept

If you remember nothing else from this pattern, remember: the Jenkins plugin manager lets you add, update, or remove features easily using simple CLI commands.

Common Mistakes

Trying to install plugins without restarting Jenkins

New plugins or updates do not take effect until Jenkins restarts

Always use the -restart flag or run a safe-restart command after installing or uninstalling plugins

Using the wrong Jenkins URL or missing authentication in CLI commands

Commands fail because they cannot connect or authenticate with the Jenkins server

Ensure the Jenkins URL is correct and provide authentication options if needed

Uninstalling plugins that other plugins depend on

This can break Jenkins functionality or cause errors

Check plugin dependencies before uninstalling and remove dependent plugins first if necessary

Summary

Use the Jenkins CLI plugin manager commands to list, install, uninstall, and restart plugins.

Always restart Jenkins after changing plugins to apply updates.

Check plugin dependencies and Jenkins URL/authentication before running commands.

Practice

1. What is the primary purpose of the Jenkins Plugin Manager?

easy

A. To monitor Jenkins build logs

B. To add, update, or remove Jenkins plugins easily

C. To create new Jenkins jobs

D. To configure Jenkins system settings

Solution

1. Step 1: Understand Jenkins Plugin Manager role

   The Plugin Manager is designed to handle plugins, which extend Jenkins features.

2. Step 2: Differentiate from other Jenkins functions

   Configuring system settings, creating jobs, and monitoring logs are separate Jenkins tasks, not plugin management.

3. Final Answer:

   To add, update, or remove Jenkins plugins easily -> Option B

4. Quick Check:

   Plugin Manager = Manage plugins [OK]

Hint: Plugin Manager is for plugins only, not jobs or settings [OK]

Common Mistakes:

• Confusing plugin management with job creation
• Thinking it manages Jenkins system settings
• Assuming it monitors build logs

2. Which menu path in Jenkins web interface leads you to the Plugin Manager?

easy

A. Manage Jenkins > Manage Plugins

B. Dashboard > New Item

C. Build History > Configure

D. Manage Jenkins > System Log

Solution

1. Step 1: Locate Plugin Manager in Jenkins UI

   The Plugin Manager is accessed via 'Manage Jenkins' then 'Manage Plugins'.

2. Step 2: Eliminate incorrect paths

   'New Item' creates jobs, 'Configure' edits builds, 'System Log' shows logs, none manage plugins.

3. Final Answer:

   Manage Jenkins > Manage Plugins -> Option A

4. Quick Check:

   Plugin Manager location = Manage Jenkins > Manage Plugins [OK]

Hint: Plugin Manager is always under Manage Jenkins > Manage Plugins [OK]

Common Mistakes:

• Selecting Dashboard > New Item by mistake
• Confusing System Log with Plugin Manager
• Choosing Build History > Configure incorrectly

3. After selecting a plugin to install in Jenkins Plugin Manager, what happens if you choose 'Install without restart'?

medium

A. The plugin downloads but requires a manual restart to activate

B. The plugin installation fails until Jenkins is restarted

C. The plugin installation is scheduled for the next Jenkins restart automatically

D. The plugin installs immediately and is usable without restarting Jenkins

Solution

1. Step 1: Understand 'Install without restart' option

   This option installs the plugin immediately and activates it without needing a restart.

2. Step 2: Compare with other options

   Other options either delay activation until restart or require manual restart; installation does not fail automatically.

3. Final Answer:

   The plugin installs immediately and is usable without restarting Jenkins -> Option D

4. Quick Check:

   Install without restart = immediate use [OK]

Hint: Install without restart means plugin is ready immediately [OK]

Common Mistakes:

• Assuming plugin needs restart to activate
• Thinking installation is scheduled for later
• Believing installation fails without restart

4. You tried to install a plugin but it did not appear in the installed list after installation. What is the most likely cause?

medium

A. You installed the plugin from the wrong Jenkins menu

B. You installed the plugin without internet connection

C. You selected 'Download now and install after restart' but did not restart Jenkins

D. The plugin is incompatible with your Jenkins version

Solution

1. Step 1: Analyze installation options

   If 'Download now and install after restart' is chosen, plugin activates only after Jenkins restarts.

2. Step 2: Check other causes

   Installing without internet would fail download; wrong menu prevents installation; incompatibility usually shows error.

3. Final Answer:

   You selected 'Download now and install after restart' but did not restart Jenkins -> Option C

4. Quick Check:

   Plugin visible after restart only if delayed install chosen [OK]

Hint: Restart Jenkins if plugin installed with delayed option [OK]

Common Mistakes:

• Not restarting Jenkins after delayed install
• Ignoring internet connection issues
• Confusing menu locations for plugin install

5. You want to update multiple plugins at once using Jenkins Plugin Manager. Which approach is best to ensure minimal downtime?

hard

A. Select all plugins and choose 'Download now and install after restart', then restart Jenkins once

B. Update each plugin one by one with 'Install without restart' option

C. Uninstall all plugins first, then install latest versions separately

D. Restart Jenkins before updating plugins to clear cache

Solution

1. Step 1: Consider updating multiple plugins efficiently

   Choosing 'Download now and install after restart' for all plugins allows batch update with a single restart.

2. Step 2: Evaluate other options

   Updating one by one without restart may cause instability; uninstalling first is unnecessary; restarting before update doesn't help.

3. Final Answer:

   Select all plugins and choose 'Download now and install after restart', then restart Jenkins once -> Option A

4. Quick Check:

   Batch update with one restart = minimal downtime [OK]

Hint: Batch update plugins, restart once after all downloads [OK]

Common Mistakes:

• Updating plugins one by one causing multiple restarts
• Uninstalling plugins unnecessarily
• Restarting Jenkins before updates without need