You can access various features in Jenkins through a command-line tool. This can be convenient for scripting of routine tasks, bulk updates, troubleshooting, and more.
Getting started
- Download the Jenkins CLI:jenkins-cli.jar
Run it as follows:
java -jar jenkins-cli.jar -s https://integration.silverpeas.org/jenkins/ help
Available Commands
| Name | Description |
|---|---|
| add-job-to-view | Ajoute des jobs à la vue. |
| build | Construit un job, et attend optionnellement sa complétion. |
| cancel-quiet-down | Annule l'effet de la commande "quiet-down". |
| clear-queue | Efface la file d'attente de build. |
| connect-node | Se reconnecte à un nœud. |
| console | Récupère la sortie console d'un build. |
| copy-job | Copie un job. |
| create-credentials-by-xml | Create Credential by XML |
| create-credentials-domain-by-xml | Create Credentials Domain by XML |
| create-job | Crée un nouveau job en lisant l'entrée standard en tant que fichier de configuration XML. |
| create-node | Crée un nouveau nœud en lisant l'entrée standard en tant que fichier de configuration XML. |
| create-view | Crée une nouvelle vue en lisant l'entrée standard en tant que fichier de configuration XML. |
| declarative-linter | Validate a Jenkinsfile containing a Declarative Pipeline |
| delete-builds | Supprime des enregistrements de build. |
| delete-credentials | Delete a Credential |
| delete-credentials-domain | Delete a Credentials Domain |
| delete-job | Supprime un/des job(s). |
| delete-node | Supprime un/des nœud(s) |
| delete-view | Supprime une/des vue(s). |
| disable-job | Désactive un job. |
| disable-plugin | Désactive un ou plusieurs plugins installés. |
| disconnect-node | Se déconnecte d'un nœud. |
| enable-job | Active un job. |
| enable-plugin | Active de façon transitive un ou plusieurs plugins installés. |
| get-credentials-as-xml | Get a Credentials as XML (secrets redacted) |
| get-credentials-domain-as-xml | Get a Credentials Domain as XML |
| get-gradle | List available gradle installations |
| get-job | Exporte la définition XML du job dans la sortie standard. |
| get-node | Exporte la définition du nœud dans la sortie standard. |
| get-view | Exporte la définition XML de la vue dans la sortie standard. |
| groovy | Exécute le script Groovy spécifié. |
| groovysh | Exécute un terminal interactif groovy. |
| help | Liste toutes les commandes disponibles ou la description détaillée d'une commande. |
| import-credentials-as-xml | Import credentials as XML. The output of "list-credentials-as-xml" can be used as input here as is, the only needed change is to set the actual Secrets which are redacted in the output. |
| install-plugin | Installe un plugin soit à partir d'un fichier, d'une URL ou depuis le centre de mise à jour. |
| keep-build | Conserver cette construction sans limite de temps. |
| list-changes | Exporte le log des changements du/des build(s) spécifié(s). |
| list-credentials | Lists the Credentials in a specific Store |
| list-credentials-as-xml | Export credentials as XML. The output of this command can be used as input for "import-credentials-as-xml" as is, the only needed change is to set the actual Secrets which are redacted in the output. |
| list-credentials-context-resolvers | List Credentials Context Resolvers |
| list-credentials-providers | List Credentials Providers |
| list-jobs | Liste tous les jobs pour une vue spécifique ou un groupe spécifique d'items. |
| list-plugins | Émet une liste de plugins installés. |
| Reads stdin and sends that out as an e-mail. | |
| offline-node | Arrête temporairement d'utiliser un nœud dédié aux builds jusqu'à la prochaine commande "online-node". |
| online-node | Reprise avec un nœud dédié aux builds, afin d'annuler la commande "offline-node" précédente. |
| quiet-down | Stoppe Jenkins silencieusement en préparation d'un redémarrage. Ne démarre aucun build. |
| reload-configuration | Efface toutes les données chargées en mémoire et en recharge l'intégralité depuis le système de fichiers. Utile quand vous avez modifié des fichiers de configuration directement depuis le disque. |
| reload-job | Recharge un/des job(s) |
| remove-job-from-view | Supprime des jobs d'une vue. |
| replay-pipeline | Replay a Pipeline build with edited script taken from standard input |
| restart | Redémarrer Jenkins |
| restart-from-stage | Restart a completed Declarative Pipeline build from a given stage. |
| safe-restart | Redémarre Jenkins en sûreté. Ne démarre aucun build. |
| safe-shutdown | Met Jenkins en mode silencieux, attend la complétion des jobs existants, puis arrête Jenkins. |
| session-id | Exporte l'identifiant de session, qui est modifié à chaque redémarrage de Jenkins. |
| set-build-description | Définit la description d'un build. |
| set-build-display-name | Définit le nom d'afichage d'un build. |
| set-external-build-result | Set external monitor job result. |
| shutdown | Arrête immédiatement le serveur Jenkins. |
| stop-builds | Stop all running builds for job(s) |
| update-credentials-by-xml | Update Credentials by XML |
| update-credentials-domain-by-xml | Update Credentials Domain by XML |
| update-job | Met à jour la définition XML du job depuis l'entrée standard. Opposé de la commande "get-job". |
| update-node | Met à jour la définition XML du nœud depuis l'entrée standard. Opposé de la commande "get-node". |
| update-view | Met à jour la définition XML de la vue depuis l'entrée standard. Opposé de la commande "get-view". |
| version | Émet la version courante. |
| wait-node-offline | Attend qu'un nœud soit hors ligne. |
| wait-node-online | Attend qu'un nœud soit en ligne. |
| who-am-i | Génère un rapport de vos informations d'identification et de vos droits. |