Tag: Command line

Perforce Command Line Global Options

by scmgalaxy KPerforceLeave a Comment on Perforce Command Line Global Options

<!– .style1 { font-size: 24px; font-weight: bold; } –>

Perforce Command Line Global Options

Global options for Perforce commands; these options can be supplied on the command line before any Perforce command.

Syntax
p4 [-cclient -ddir -Hhost -pport -Ppass -uuser -xfile -Ccharset -Qcharset -Llanguage] [-G] [-s] [-z tag] cmd [args …]
p4 -V
p4 -h

 

Options
 
-c client
Overrides any P4CLIENT setting with the specified client name.
-d dir
Overrides any PWD setting (i.e. current working directory) and replaces it with the specified directory.
-G
Causes all output (and batch input for form commands with -i) to be formatted as marshalled Python dictionary objects. This is most often used when scripting.
-H host
Overrides any P4HOST setting and replaces it with the specified hostname.
-p port
Overrides any P4PORT setting with the specified port number.
-P pass
Overrides any P4PASSWD setting with the specified password.
-s
Prepends a descriptive field (for example, text:, info:, error:, exit:) to each line of output produced by a Perforce command. This is most often used when scripting.
-u user
Overrides any P4USER, USER, or USERNAME setting with the specified user name.
-x file
Instructs Perforce to read arguments, one per line, from the specified file. If file is a single hyphen (-), then standard input is read.
-C charset
Overrides any P4CHARSET setting with the specified character set.
-Q charset
Overrides any P4COMMANDCHARSET setting with the specified character set.
-L language
This feature is reserved for system integrators.
-z tag
Causes output of many reporting commands to be in the same tagged format as that generated by p4 fstat.
-V
Displays the version of the p4 client program and exits.
-h
Displays basic usage information and exits.

 

Usage Notes
•
Be aware that the global options must be specified on the command line before the Perforce command. Options specified after the Perforce command will not be interpreted as global options, but as options for the command being invoked. It is therefore possible to have the same command line option appearing twice in the same command, being interpreted differently each time.
For example, the command p4 -c anotherclient edit -c 140 file.c will open file file.c for edit in pending changelist 140 under client workspace anotherclient.
•
The -x option is useful for automating tedious tasks; a user adding several files at once could create a text file with the names of these files and invoke p4 -x textfile add to add them all at once.
The -x option can be extremely powerful – as powerful as whatever generates its input. For example, a UNIX developer wishing to edit any file referring to an included file.h file, for instance, could grep -l file.h *.c | cut -f1 -d: | p4 -x – edit.
In this example, the grep command lists occurrences of file.h in the *.c files, the -l option tells grep to list each file only once, and the cut command splits off the filename from grep’s output before passing it to the p4 -x command.
•
The -s option can be useful in automated scripts.
For example, a script could be written as part of an in-house build process which executes p4 -s commands, discards any output lines beginning with “info:”, and alerts the user if any output lines begin with “error:”.
•
Python developers will find the -G option extremely useful for scripting. For instance, to get a dictionary of all fields of a job whose ID is known, use the following:
job_dict = marshal.load(os.popen(‘p4 -G job -o ‘ + job_id, ‘rb’))
In some cases, it may not be intuitively obvious what keys are used by the client program. If you pipe the output of any p4 -G invocation to the following script, you will see every record printed out in key/value pairs:
Tagged : / / / / /

Perforce Command Line

by scmgalaxy KPerforceLeave a Comment on Perforce Command Line

Command

Description
p4 add
 Open file(s) in a client workspace for addition to the depot.
p4 admin
 Perform administrative operations on the server.
p4 branch
 Create or edit a branch specification and its view.
p4 change
 Create or edit a changelist specification.
p4 changelists
 List submitted and pending changelists.
p4 changelist
 Create or edit a changelist specification.
p4 client
 Create or edit a client workspace specification and its view.
p4 clients
 List all client workspaces currently known to the system.
p4 delete
 Open file(s) in a client workspace for deletion from the depot.
p4 depot
 Create or edit a depot specification.
p4 depots
 Display a list of depots known to the Perforce server.
p4 describe
 Provides information about changelists and the changelists’ files.
p4 groups
 List groups of users.
p4 group
 Add or delete users from a group, or set the maxresults, maxscanrows, and timeout limits for the members of a group.
p4 have
 List files and revisions that have been synced to the client workspace
p4 info
 Display information about the current client and server.
p4 integrate
 Open files for branching or merging.
p4 integrated
 Show integrations that have been submitted.
p4 job
 Create or edit a defect, enhancement request, or other job specification.
p4 jobs
 List jobs known to the Perforce server.
p4 label
 Create or edit a label specification and its view.
p4 labels
 Display list of defined labels.
p4 lock
 Lock an opened file against changelist submission.
p4 login
 Log in to a Perforce server by obtaining a ticket.
p4 logout
 Log out of a Perforce server by removing or invalidating a ticket.
p4 passwd
 Change a user’s Perforce password on the server.
p4 rename
 Renaming files under Perforce.
p4 resolve
 Resolve conflicts between file revisions.
p4 revert
 Discard changes made to open files.
p4 set
 Set Perforce variables in the Windows registry.
p4 submit
 Send changes made to open files to the depot.
p4 sync
 Copy files from the depot into the workspace.
p4 tag
 Tag files with a label.
p4 triggers
 Edit a list of scripts to be run conditionally whenever changelists are submitted, forms are updated, or when integrating Perforce with external authentication mechanisms.
p4 user
 Create or edit Perforce user specifications and preferences.
p4 users
 Print a list of all known users of the current server.
p4 verify
 Verify that the server archives are intact.
p4 workspace
 Create or edit a client workspace specification and its view.
Tagged : / / / / /

Java Command Line Options

by scmgalaxy KConcept & DefinitionLeave a Comment on Java Command Line Options

-client       to select the “client” VM
-server       to select the “server” VM
-hotspot      is a synonym for the “client” VM  [deprecated]
The default VM is client.

-cp <class search path of directories and zip/jar files>
-classpath <class search path of directories and zip/jar files>
A ; separated list of directories, JAR archives,
and ZIP archives to search for class files.
-D<name>=<value>
set a system property
-verbose[:class|gc|jni]
enable verbose output
-version      print product version and exit
-version:<value>
require the specified version to run
-showversion  print product version and continue
-jre-restrict-search | -jre-no-restrict-search
include/exclude user private JREs in the version search
-? -help      print this help message
-X            print help on non-standard options
-ea[:<packagename>…|:<classname>]
-enableassertions[:<packagename>…|:<classname>]
enable assertions
-da[:<packagename>…|:<classname>]
-disableassertions[:<packagename>…|:<classname>]
disable assertions
-esa | -enablesystemassertions
enable system assertions
-dsa | -disablesystemassertions
disable system assertions
-agentlib:<libname>[=<options>]
load native agent library <libname>, e.g. -agentlib:hprof
see also, -agentlib:jdwp=help and -agentlib:hprof=help
-agentpath:<pathname>[=<options>]
load native agent library by full pathname
-javaagent:<jarpath>[=<options>]
load Java programming language agent, see java.lang.instrument
-splash:<imagepath>
show splash screen with specified image

Tagged : / / /

Complete guide to use Jenkins CLI / Command line | Jenkins Tutorials

by scmgalaxy KJenkins / UncategorizedLeave a Comment on Complete guide to use Jenkins CLI / Command line | Jenkins Tutorials
jenkins-cli-command-line
Complete guide to use Jenkins CLI / Command line?
Run Jenkins build from command is very simple in Linux system. If you are using using windows, gitbash is a recommended which has bash shell in built. You can use windows command line as well. Jenkins has support to command line client that allows you to access Jenkins from command line.
To Trigger Jenkins build from command line some prerequisite are there
Jenkins service is running.
Enable security option under “Configure Global Security”
Go to jenkins dashboard in Home page ( e.g http://localhost:8080/ ) -> Manage Jenkins
-> Configure Global Security -> Click on “Enable security” checkbox

You can also configure “Access Control” and “Authorization” option in Global Security page.

Download Jenkins-cli.jar
Download Jenkins-cli.jar from http://<your_jenkins_server_url>/jnlpJars/jenkins-cli.jar. (Here <your_jenkins_server_url> is your respective Jenkins server URL (development or staging))
Go to http://<your_jenkins_server_url>/cli and build your command by following the instructions there.
How to login to Jenkins using commands
If your Jenkins requires authentication, use –username and –password or –password-file options to specify the credentials. To avoid doing this for every command, you can also use the login CLI command once (with the same credentials parameters), and after that you may use other commands without specifying credentials.
Whenever the CLI tries to to connect to the Jenkins server, it offers the before mentioned SSH keys. When the user has those keys but don’t want use them to authenticate, preventing being prompted by the key’s password, it’s possible to use the -noKeyAuth argument. This way the CLI will never try to use the SSH keys available. failure to authenticate by itself does not constitute a fatal error. It will instead try to execute the command anyway, as the anonymous user.
Login Jenkins using username and Password
Jenkins allow us to trigger Jenkins build with any specific user, For that we have to pass username and password in command line.
$ java -jar “/tmp/kitchen/cache/jenkins-cli.jar” -s http://localhost:8080 who-am-i –username jenkins –password foobar
$ java -jar jenkins-cli.jar -s http://myjenkins help –username me –password mypassword
Login Jenkins using public keys
Starting 1.419 (which will be out July 4th), Jenkins CLI supports authentication based on the SSH key pair. Just like CloudBees DEV@cloud (or GitHub, or other similar sites), you interactively login from the web UI, then associate your public keys with your user account. Then CLI will silently authenticates itself using your ~/.ssh/id_rsa, ~/.ssh/id_dsa, or ~/.ssh/identity.
https://help.github.com/articles/generating-an-ssh-key/
Login Jenkins using private keys
You can also pass the priate key as follows
To use the -i option the syntax is as follows:
$ java -jar jenkins-cli.jar -s http://myjenkins help -i ~/.ssh/id_rsa
$ java -jar jenkins-cli.jar [-s JENKINS_URL] [-i PRIVATE_KEY] command [options…] [arguments…]
For compatibility reasons, unless you use the -i option,
Login Jenkins using initialAdminPassword
try user “admin” and password from “Jenkins\secrets\initialAdminPassword”
java -jar jenkins-cli.jar -s http://localhost:8080 who-am-i –username admin –password fe3f1e1624ea4be8873b7a35e28b24be
Login Jenkins using passphrase
Go to http://jenkins-serer:8085/user/admin/configure and set the passphrase in “SSH Public Keys” and use the same passphrase with jenkins commands.
E.g 1 – Getting help
The list of the available commands depends on the server you are talking to. Visit https://jenkins.example.com/cli or use ‘help’ command to list them all:
> java -jar jenkins-cli.jar -s https://jenkins.example.com help [command]
E.g 2 – Run Jenkins Build From Command Line
> java -jar jenkins-cli.jar -s http://<jenkins server>/ build build-name [-c] [-f] [-p] [-r N] [-s] [-v] [-w]
build-name : Name of the job to build
-c  : Check for SCM changes before starting the build, and if there’s no change, exit without doing a build
-f  : Follow the build progress. Like -s only interrupts are not passed through to the build.
-p  : Specify the build parameters in the key=value format.
-s  : Wait until the completion/abortion of the command. Interrupts are passed through to the build.
-v  : Prints out the console output of the build. Use with -s
-w  : Wait until the start of the command
Example  – java -jar jenkins-cli.jar -s http://localhost:8080/ build ‘my-project-build’ –username roop –password roop
E.g 3 – List all jobs under the view: tools
$ java -jar jenkins-cli.jar -s http://jenkins/ list-jobs tools
E.g 4 – Get the configuration of the job: template
$ java -jar jenkins-cli.jar -s http://jenkins/ get-job template > template.xml
E.g 5 – Create a new job based on the configuration
$ java -jar jenkins-cli.jar -s http://jenkins/ create-job new_job_name < new_job_name.xml
E.g 6 – Run groovy script
$ java -jar jenkins-cli.jar -s http://jenkins/ groovy scripts/add_job_to_view.groovy
If there are any parameters in the script, just as:
import jenkins.model.*
if (args.length != 2 ) {
  println “Error on arguments!”
}
def jobName  = args[0] ?: ‘a_job’
def viewName = args[1] ?: ‘a_view’
println jobName + ‘ ‘ + viewName
def v = Jenkins.instance.getView(viewName)
def i = Jenkins.instance.getItemByFullName(jobName)
if (v && i) {
  v.add(i)
}
pass the parameters as:
$ java -jar jenkins-cli.jar -s http://jenkins/ groovy scripts/add_job_to_view.groovy JOB_NAME VIEM_NAME
E.g 7 – Build a job
$ java -jar jenkins-cli.jar -s http://jenkins/ build new_job_name
E.g 8 – Diable a job
$ java -jar jenkins-cli.jar -s http://jenkins/ disable-job new_job_name
E.g 8 – Passing parameters when triggering a job build
Job parameters are a very handy concept. Perhaps you’ve only ever used Jenkins or another CI system to automatically run builds when a remote SCM/git repo changes. You can also trigger builds manually from within Jenkins. And whilst you’re doing that, your job can prompt for parameters to the build.
For example, we have a job named similar to “Deploy XYZ App”. It has the git repo hardcoded in the job like a normal build, but when you press “Build”, it shows a list of options: string fields, drop-down lists, etc.
When the job runs, you can use these values anywhere within your job’s configuration. Its very cool.
But how to pass those same parameters via the CLI? You use the -p key=value flag for each parameter you want to pass.
So our finished product might look like:
$ java -jar jenkins-cli.jar -s http://myjenkins build ‘Deploy XYZ App’ -i ~/.ssh/id_rsa -s -v -p target_env=api.cloudfoundry.com -p branch=master
Commons problems
Operation timed out
$ java -jar jenkins-cli.jar -s YOUR_SERVER_URL help
Exception in thread “main” java.net.ConnectException: Operation timed out
at java.net.PlainSocketImpl.socketConnect(Native Method)
at java.net.PlainSocketImpl.doConnect(PlainSocketImpl.java:351)
at java.net.PlainSocketImpl.connectToAddress(PlainSocketImpl.java:213)
at java.net.PlainSocketImpl.connect(PlainSocketImpl.java:200)
at java.net.SocksSocketImpl.connect(SocksSocketImpl.java:432)
at java.net.Socket.connect(Socket.java:529)
at java.net.Socket.connect(Socket.java:478)
at java.net.Socket.<init>(Socket.java:375)
at java.net.Socket.<init>(Socket.java:189)
at hudson.cli.CLI.<init>(CLI.java:97)
at hudson.cli.CLI.<init>(CLI.java:82)
at hudson.cli.CLI._main(CLI.java:250)
at hudson.cli.CLI.main(CLI.java:199)
Check that the JNLP port is opened if you are using a firewall on your server. You can configure its value in Jenkins configuration. By default it is set to use a random port.
java.io.IOException: No X-Jenkins-CLI2-Port
java.io.IOException: No X-Jenkins-CLI2-Port among [X-Jenkins, null, Server, X-Content-Type-Options, Connection, X-You-Are-In-Group, X-Hudson, X-Permission-Implied-By, Date, X-Jenkins-Session, X-You-Are-Authenticated-As, X-Required-Permission, Set-Cookie, Expires, Content-Length, Content-Type]
at hudson.cli.CLI.getCliTcpPort(CLI.java:284)
at hudson.cli.CLI.<init>(CLI.java:128)
at hudson.cli.CLIConnectionFactory.connect(CLIConnectionFactory.java:72)
at hudson.cli.CLI._main(CLI.java:473)
at hudson.cli.CLI.main(CLI.java:384)
Suppressed: java.io.IOException: Server returned HTTP response code: 403 for URL: http://citest.gce.px/cli
at sun.net.www.protocol.http.HttpURLConnection.getInputStream0(HttpURLConnection.java:1840)
at sun.net.www.protocol.http.HttpURLConnection.getInputStream(HttpURLConnection.java:1441)
at hudson.cli.FullDuplexHttpStream.<init>(FullDuplexHttpStream.java:78)
at hudson.cli.CLI.connectViaHttp(CLI.java:152)
at hudson.cli.CLI.<init>(CLI.java:132)
… 3 more
Solution: Go to Manage Jenkins -> Configure Global Security -> “TCP port for JNLP agents”: choose fixed or random
Reference
Tagged : / / / / / / / /

Docker Command line Reference | Docker Tutorial | Docker Guide

by scmgalaxy KCONTAINERSLeave a Comment on Docker Command line Reference | Docker Tutorial | Docker Guide
One liner to stop all of Docker containers:
> docker stop $(docker ps -a -q)
One liner to remove all of Docker containers:
> docker rm $(docker ps -a -q)
OR
> docker rm $(docker images -q)
OR
> docker rmi $(docker images -q)
In case of error message Get http:///var/run/docker.sock/v1.14/containers/json?all=1: dial unix /var/run/docker.sock: permission denied
> sudo docker rm $(sudo docker ps -a -q)
To only stop exited containers and delete only non-tagged images.:
> docker ps –filter ‘status=Exited’ -a | xargs docker stop
> docker images –filter “dangling=true” -q | xargs docker rmi
Remove all containers that aren’t currently running:
> docker rm $(docker ps -a -q -f “status=exited*”)
if not the volumes will not be delete !!! (like if you are using a mysql docker image) and all the volumes will be orphans !
> sudo docker rm -f -v $(sudo docker ps -a -q)
Tagged : / / / / / / / /

Chef Commands Line Reference | Chef Commands Line Guide | Cheatsheet

by scmgalaxy KChefLeave a Comment on Chef Commands Line Reference | Chef Commands Line Guide | Cheatsheet

chef-commands-line-reference

To run single recipe using chef-solo

> chef-solo -c /opt/chef/repo/config/solo.rb -o my_cookbook::recipe

To run the single reciepe in same machine

> chef-apply hello.rb

To generate the cookbook standard structure

> chef generate cookbook learn_chef_httpd
> knife cookbook create smartmontools -r md

To generate the template file in cookbook

> chef generate template learn_chef_httpd index.html

To run the cookbook in local mode

> sudo chef-client --local-mode --runlist ‘recipe[learn_chef_httpd]’


To download the cookbooks from market place


> knife cookbook site download learn_chef_httpd


> knife cookbook site install learn_chef_httpd




To Upload the cookbooks to chef server


> knife cookbook upload learn_chef_httpd


> knife cookbook upload -a


To bootstrap a nodes


> knife bootstrap {{address}} --ssh-user {{user}} --ssh-password '{{password}}' --sudo --use-sudo-password --node-name node1 --run-list 'recipe[learn_chef_apache2]'


> knife bootstrap uvo1t75faaktzc532w6.vm.cld.sr -x root -P Br356YS0iy –sudo –node-name firefox


> knife bootstrap 123.45.6.789 -x username -P password –sudo




To see the list of nodes


>knife node list


To edit the node run list


> knife node edit name_of_node


To see the info about each nodes


> knife node show node1


Run the cooksbooks on nodes


> knife ssh {{address}} 'sudo chef-client' --manual-list --ssh-user {{user}} --ssh-password '{{password}}'


> ssh username@ipadddress -i mycredentials.pem sudo chef-client


To add the run list to the nodes.


knife node run_list add C2445575914.domain 'recipe[hptrain]'


knife node run_list set test-node '''recipe[iptables]''' [Windows - Powershell]


knife node run_list set test-node 'recipe[iptables]' [Windows - Command]








Tagged :  /  /  /  /  /  /  /  /  /  /  /  / 	










Know About Jenkins CLI | Jenkins CLI Guide
		

 by scmgalaxy KJenkinsLeave a Comment on Know About Jenkins CLI | Jenkins CLI Guide		











jenkins-cli


Running CLI

java -jar jenkins-cli.jar [-s JENKINS_URL] command [options…] [arguments…]


Getting help

java -jar jenkins-cli.jar -s yourserver.com help [command]


How to download jenkins-cli.jar?

The best place to download the Jenkins CLI jar is from your own Jenkins server. This means you’ll have the matching CLI version. Visit the /cli endpoint, such as http://yourserver.com/cli, and it will give you a link to download the jar (the /jnlpJars/jenkins-cli.jar endpoint). Download that jar.


Running commands against a secure Jenkins (basic auth or ssh keys)


If your Jenkins is secured, and it probably is so that you control who can create jobs, run jobs, view results, then the command above may fail and ask for credentials.

You have two options: provide –username & –password options to every command or provide -i option and provide the path to the ssh private key that matches the public key you provided to your user account.

For example:


$ java -jar jenkins-cli.jar -s http://myjenkins help –username me –password mypassword

$ java -jar jenkins-cli.jar -s http://myjenkins help -i ~/.ssh/id_rsa


Passing parameters when triggering a job build

To pass those same parameters via the CLI? You use the -p key=value flag for each parameter you want to pass.


So our finished product might look like:


$ java -jar jenkins-cli.jar -s http://myjenkins build ‘Deploy XYZ App’ -i ~/.ssh/id_rsa -s -v -p target_env=api.cloudfoundry.com -p branch=master


How to get all commands for Jenkins CLI-

Run > http://yourserver.com/cli


java -jar jenkins-cli.jar -s http://fmsscm.corp.intuit.net/qbo-qa/ help


Available Commands


    

  • build: Builds a job, and optionally waits until its completion.
    • 

  • cancel-quiet-down: Cancel the effect of the “quiet-down” command.
    • 

  • clear-queue: Clears the build queue
    • 

  • connect-node: Reconnect to a node
    • 

  • console: Retrieves console output of a build
    • 

  • copy-job: Copies a job.
    • 

  • create-job: Creates a new job by reading stdin as a configuration XML file.
    • 

  • create-node: Creates a new node by reading stdin as a XML configuration.
    • 

  • delete-builds: Deletes build record(s).
    • 

  • delete-job: Deletes a job
    • 

  • delete-node: Deletes a node
    • 

  • disable-job: Disables a job
    • 

  • disconnect-node: Disconnects from a node
    • 

  • enable-job: Enables a job
    • 

  • get-job: Dumps the job definition XML to stdout
    • 

  • get-node: Dumps the node definition XML to stdout
    • 

  • groovy: Executes the specified Groovy script.
    • 

  • groovysh: Runs an interactive groovy shell.
    • 

  • help: Lists all the available commands.
    • 

  • install-plugin: Installs a plugin either from a file, an URL, or from update center.
    • 

  • install-tool: Performs automatic tool installation, and print its location to stdout. Can be only called from inside a build.
    • 

  • keep-build: Mark the build to keep the build forever.
    • 

  • list-changes: Dumps the changelog for the specified build(s).
    • 

  • list-jobs: Lists all jobs in a specific view or item group.
    • 

  • list-plugins: Outputs a list of installed plugins.
    • 

  • login: Saves the current credential to allow future commands to run without explicit credential information.
    • 

  • logout: Deletes the credential stored with the login command.
    • 

  • mail: Reads stdin and sends that out as an e-mail.
    • 

  • offline-node: Stop using a node for performing builds temporarily, until the next “online-node” command.
    • 

  • online-node: Resume using a node for performing builds, to cancel out the earlier “offline-node” command.
    • 

  • quiet-down: Quiet down Jenkins, in preparation for a restart. Don’t start any builds.
    • 

  • reload-configuration: Discard all the loaded data in memory and reload everything from file system. Useful when you modified config files directly on disk.
    • 

  • restart: Restart Jenkins
    • 

  • safe-restart: Safely restart Jenkins
    • 

  • safe-shutdown: Puts Jenkins into the quiet mode, wait for existing builds to be completed, and then shut down Jenkins.
    • 

  • session-id: Outputs the session ID, which changes every time Jenkins restarts
    • 

  • set-build-description: Sets the description of a build.
    • 

  • set-build-display-name: Sets the displayName of a build
    • 

  • set-build-parameter: Update/set the build parameter of the current build in progress
    • 

  • set-build-result: Sets the result of the current build. Works only if invoked from within a build.
    • 

  • set-external-build-result: Set external monitor job result.
    • 

  • set-next-build-number: Set build number to be used for next build.
    • 

  • shutdown: Immediately shuts down Jenkins server
    • 

  • update-job: Updates the job definition XML from stdin. The opposite of the get-job command
    • 

  • update-node: Updates the node definition XML from stdin. The opposite of the get-node command
    • 

  • version: Outputs the current version.
    • 

  • wait-node-offline: Wait for a node to become offline
    • 

  • wait-node-online: Wait for a node to become online
    • 

  • who-am-i: Reports your credential and permissions
    • 



Reference –

https://wiki.jenkins-ci.org/display/JENKINS/Jenkins+CLI

http://stackoverflow.com/questions/18199355/jenkins-cli-authentication

http://stackoverflow.com/questions/16617232/jenkins-cli-public-key-authentication-where-to-put-my-public-key-in-jenkins








Tagged :  /  /  /  /  /  /  /  /  /  / 	








Understand Jenkins CLI | Jenkins CLI Reference
		

 by scmgalaxy KJenkinsLeave a Comment on Understand Jenkins CLI | Jenkins CLI Reference		











jenkins-cli


Running CLI

java -jar jenkins-cli.jar [-s JENKINS_URL] command [options…] [arguments…]


Getting help

java -jar jenkins-cli.jar -s yourserver.com help [command]


How to download jenkins-cli.jar?

The best place to download the Jenkins CLI jar is from your own Jenkins server. This means you’ll have the matching CLI version. Visit the /cli endpoint, such as http://yourserver.com/cli, and it will give you a link to download the jar (the /jnlpJars/jenkins-cli.jar endpoint). Download that jar.


Running commands against a secure Jenkins (basic auth or ssh keys)


If your Jenkins is secured, and it probably is so that you control who can create jobs, run jobs, view results, then the command above may fail and ask for credentials.

You have two options: provide –username & –password options to every command or provide -i option and provide the path to the ssh private key that matches the public key you provided to your user account.

For example:


$ java -jar jenkins-cli.jar -s http://myjenkins help –username me –password mypassword

$ java -jar jenkins-cli.jar -s http://myjenkins help -i ~/.ssh/id_rsa


Passing parameters when triggering a job build

To pass those same parameters via the CLI? You use the -p key=value flag for each parameter you want to pass.


So our finished product might look like:


$ java -jar jenkins-cli.jar -s http://myjenkins build ‘Deploy XYZ App’ -i ~/.ssh/id_rsa -s -v -p target_env=api.cloudfoundry.com -p branch=master


How to get all commands for Jenkins CLI-

Run > http://yourserver.com/cli


java -jar jenkins-cli.jar -s http://fmsscm.corp.intuit.net/qbo-qa/ help


Available Commands


    

  • build: Builds a job, and optionally waits until its completion.
    • 

  • cancel-quiet-down: Cancel the effect of the “quiet-down” command.
    • 

  • clear-queue: Clears the build queue
    • 

  • connect-node: Reconnect to a node
    • 

  • console: Retrieves console output of a build
    • 

  • copy-job: Copies a job.
    • 

  • create-job: Creates a new job by reading stdin as a configuration XML file.
    • 

  • create-node: Creates a new node by reading stdin as a XML configuration.
    • 

  • delete-builds: Deletes build record(s).
    • 

  • delete-job: Deletes a job
    • 

  • delete-node: Deletes a node
    • 

  • disable-job: Disables a job
    • 

  • disconnect-node: Disconnects from a node
    • 

  • enable-job: Enables a job
    • 

  • get-job: Dumps the job definition XML to stdout
    • 

  • get-node: Dumps the node definition XML to stdout
    • 

  • groovy: Executes the specified Groovy script.
    • 

  • groovysh: Runs an interactive groovy shell.
    • 

  • help: Lists all the available commands.
    • 

  • install-plugin: Installs a plugin either from a file, an URL, or from update center.
    • 

  • install-tool: Performs automatic tool installation, and print its location to stdout. Can be only called from inside a build.
    • 

  • keep-build: Mark the build to keep the build forever.
    • 

  • list-changes: Dumps the changelog for the specified build(s).
    • 

  • list-jobs: Lists all jobs in a specific view or item group.
    • 

  • list-plugins: Outputs a list of installed plugins.
    • 

  • login: Saves the current credential to allow future commands to run without explicit credential information.
    • 

  • logout: Deletes the credential stored with the login command.
    • 

  • mail: Reads stdin and sends that out as an e-mail.
    • 

  • offline-node: Stop using a node for performing builds temporarily, until the next “online-node” command.
    • 

  • online-node: Resume using a node for performing builds, to cancel out the earlier “offline-node” command.
    • 

  • quiet-down: Quiet down Jenkins, in preparation for a restart. Don’t start any builds.
    • 

  • reload-configuration: Discard all the loaded data in memory and reload everything from file system. Useful when you modified config files directly on disk.
    • 

  • restart: Restart Jenkins
    • 

  • safe-restart: Safely restart Jenkins
    • 

  • safe-shutdown: Puts Jenkins into the quiet mode, wait for existing builds to be completed, and then shut down Jenkins.
    • 

  • session-id: Outputs the session ID, which changes every time Jenkins restarts
    • 

  • set-build-description: Sets the description of a build.
    • 

  • set-build-display-name: Sets the displayName of a build
    • 

  • set-build-parameter: Update/set the build parameter of the current build in progress
    • 

  • set-build-result: Sets the result of the current build. Works only if invoked from within a build.
    • 

  • set-external-build-result: Set external monitor job result.
    • 

  • set-next-build-number: Set build number to be used for next build.
    • 

  • shutdown: Immediately shuts down Jenkins server
    • 

  • update-job: Updates the job definition XML from stdin. The opposite of the get-job command
    • 

  • update-node: Updates the node definition XML from stdin. The opposite of the get-node command
    • 

  • version: Outputs the current version.
    • 

  • wait-node-offline: Wait for a node to become offline
    • 

  • wait-node-online: Wait for a node to become online
    • 

  • who-am-i: Reports your credential and permissions
    • 



Reference –

https://wiki.jenkins-ci.org/display/JENKINS/Jenkins+CLI

http://stackoverflow.com/questions/18199355/jenkins-cli-authentication

http://stackoverflow.com/questions/16617232/jenkins-cli-public-key-authentication-where-to-put-my-public-key-in-jenkins








Tagged :  /  /  /  /  /  /  /  /  /  /