{"id":2036,"date":"2021-12-22T13:53:55","date_gmt":"2021-12-22T13:53:55","guid":{"rendered":"http:\/\/www.scmgalaxy.com\/tutorials\/?p=2036"},"modified":"2022-03-04T12:52:47","modified_gmt":"2022-03-04T12:52:47","slug":"jenkins-commands-lines-reference-from-jenkins","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/jenkins-commands-lines-reference-from-jenkins\/","title":{"rendered":"Jenkins commands lines reference from jenkins using jenkins-cli.jar"},"content":{"rendered":"\n

You can access various features in Jenkins through a command-line tool. See the documentation<\/a> for more details of this feature. To get started, download jenkins-cli.jar<\/a>, and run it as follows:<\/p>\n\n\n\n

java -jar jenkins-cli.jar<\/a> -s http:\/\/13.235.81.87:8080\/ -webSocket help<\/pre>\n\n\n\n
Available Commands<\/h2>\n\n\n\n
add-job-to-view<\/a><\/td>Adds jobs to view.<\/td><\/tr>
build<\/a><\/td>Builds a job, and optionally waits until its completion.<\/td><\/tr>
cancel-quiet-down<\/a><\/td>Cancel the effect of the “quiet-down” command.<\/td><\/tr>
clear-queue<\/a><\/td>Clears the build queue.<\/td><\/tr>
connect-node<\/a><\/td>Reconnect to a node(s)<\/td><\/tr>
console<\/a><\/td>Retrieves console output of a build.<\/td><\/tr>
copy-job<\/a><\/td>Copies a job.<\/td><\/tr>
create-credentials-by-xml<\/a><\/td>Create Credential by XML<\/td><\/tr>
create-credentials-domain-by-xml<\/a><\/td>Create Credentials Domain by XML<\/td><\/tr>
create-job<\/a><\/td>Creates a new job by reading stdin as a configuration XML file.<\/td><\/tr>
create-node<\/a><\/td>Creates a new node by reading stdin as a XML configuration.<\/td><\/tr>
create-view<\/a><\/td>Creates a new view by reading stdin as a XML configuration.<\/td><\/tr>
declarative-linter<\/a><\/td>Validate a Jenkinsfile containing a Declarative Pipeline<\/td><\/tr>
delete-builds<\/a><\/td>Deletes build record(s).<\/td><\/tr>
delete-credentials<\/a><\/td>Delete a Credential<\/td><\/tr>
delete-credentials-domain<\/a><\/td>Delete a Credentials Domain<\/td><\/tr>
delete-job<\/a><\/td>Deletes job(s).<\/td><\/tr>
delete-node<\/a><\/td>Deletes node(s)<\/td><\/tr>
delete-view<\/a><\/td>Deletes view(s).<\/td><\/tr>
disable-job<\/a><\/td>Disables a job.<\/td><\/tr>
disable-plugin<\/a><\/td>Disable one or more installed plugins.<\/td><\/tr>
disconnect-node<\/a><\/td>Disconnects from a node.<\/td><\/tr>
enable-job<\/a><\/td>Enables a job.<\/td><\/tr>
enable-plugin<\/a><\/td>Enables one or more installed plugins transitively.<\/td><\/tr>
get-credentials-as-xml<\/a><\/td>Get a Credentials as XML (secrets redacted)<\/td><\/tr>
get-credentials-domain-as-xml<\/a><\/td>Get a Credentials Domain as XML<\/td><\/tr>
get-gradle<\/a><\/td>List available gradle installations<\/td><\/tr>
get-job<\/a><\/td>Dumps the job definition XML to stdout.<\/td><\/tr>
get-node<\/a><\/td>Dumps the node definition XML to stdout.<\/td><\/tr>
get-view<\/a><\/td>Dumps the view definition XML to stdout.<\/td><\/tr>
groovy<\/a><\/td>Executes the specified Groovy script.<\/td><\/tr>
groovysh<\/a><\/td>Runs an interactive groovy shell.<\/td><\/tr>
help<\/a><\/td>Lists all the available commands or a detailed description of single command.<\/td><\/tr>
import-credentials-as-xml<\/a><\/td>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.<\/td><\/tr>
install-plugin<\/a><\/td>Installs a plugin either from a file, an URL, or from update center.<\/td><\/tr>
keep-build<\/a><\/td>Mark the build to keep the build forever.<\/td><\/tr>
list-changes<\/a><\/td>Dumps the changelog for the specified build(s).<\/td><\/tr>
list-credentials<\/a><\/td>Lists the Credentials in a specific Store<\/td><\/tr>
list-credentials-as-xml<\/a><\/td>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.<\/td><\/tr>
list-credentials-context-resolvers<\/a><\/td>List Credentials Context Resolvers<\/td><\/tr>
list-credentials-providers<\/a><\/td>List Credentials Providers<\/td><\/tr>
list-jobs<\/a><\/td>Lists all jobs in a specific view or item group.<\/td><\/tr>
list-plugins<\/a><\/td>Outputs a list of installed plugins.<\/td><\/tr>
mail<\/a><\/td>Reads stdin and sends that out as an e-mail.<\/td><\/tr>
offline-node<\/a><\/td>Stop using a node for performing builds temporarily, until the next “online-node” command.<\/td><\/tr>
online-node<\/a><\/td>Resume using a node for performing builds, to cancel out the earlier “offline-node” command.<\/td><\/tr>
quiet-down<\/a><\/td>Quiet down Jenkins, in preparation for a restart. Don\u2019t start any builds.<\/td><\/tr>
reload-configuration<\/a><\/td>Discard all the loaded data in memory and reload everything from file system. Useful when you modified config files directly on disk.<\/td><\/tr>
reload-job<\/a><\/td>Reload job(s)<\/td><\/tr>
remove-job-from-view<\/a><\/td>Removes jobs from view.<\/td><\/tr>
replay-pipeline<\/a><\/td>Replay a Pipeline build with edited script taken from standard input<\/td><\/tr>
restart<\/a><\/td>Restart Jenkins.<\/td><\/tr>
restart-from-stage<\/a><\/td>Restart a completed Declarative Pipeline build from a given stage.<\/td><\/tr>
safe-restart<\/a><\/td>Safely restart Jenkins.<\/td><\/tr>
safe-shutdown<\/a><\/td>Puts Jenkins into the quiet mode, wait for existing builds to be completed, and then shut down Jenkins.<\/td><\/tr>
session-id<\/a><\/td>Outputs the session ID, which changes every time Jenkins restarts.<\/td><\/tr>
set-build-description<\/a><\/td>Sets the description of a build.<\/td><\/tr>
set-build-display-name<\/a><\/td>Sets the displayName of a build.<\/td><\/tr>
set-external-build-result<\/a><\/td>Set external monitor job result.<\/td><\/tr>
shutdown<\/a><\/td>Immediately shuts down Jenkins server.<\/td><\/tr>
stop-builds<\/a><\/td>Stop all running builds for job(s)<\/td><\/tr>
update-credentials-by-xml<\/a><\/td>Update Credentials by XML<\/td><\/tr>
update-credentials-domain-by-xml<\/a><\/td>Update Credentials Domain by XML<\/td><\/tr>
update-job<\/a><\/td>Updates the job definition XML from stdin. The opposite of the get-job command.<\/td><\/tr>
update-node<\/a><\/td>Updates the node definition XML from stdin. The opposite of the get-node command.<\/td><\/tr>
update-view<\/a><\/td>Updates the view definition XML from stdin. The opposite of the get-view command.<\/td><\/tr>
version<\/a><\/td>Outputs the current version.<\/td><\/tr>
wait-node-offline<\/a><\/td>Wait for a node to become offline.<\/td><\/tr>
wait-node-online<\/a><\/td>Wait for a node to become online.<\/td><\/tr>
who-am-i<\/a><\/td>Reports your credential and permissions.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/p>\n\n\n\n
<\/p>\n\n\n