| 
									
										
										
										
											2012-05-22 15:10:02 +02:00
										 |  |  | cdist-remote-exec-copy(7)
 | 
					
						
							|  |  |  | =========================
 | 
					
						
							| 
									
										
										
										
											2016-05-20 08:50:56 +02:00
										 |  |  | How to use remote exec and copy
 | 
					
						
							| 
									
										
										
										
											2012-05-22 15:10:02 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2016-05-20 08:50:56 +02:00
										 |  |  | Nico Schottelius <nico-cdist--@--schottelius.org>
 | 
					
						
							| 
									
										
										
										
											2012-05-22 15:10:02 +02:00
										 |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | INTRO
 | 
					
						
							| 
									
										
										
										
											2012-05-29 13:33:22 +02:00
										 |  |  | -----
 | 
					
						
							|  |  |  | Cdist interacts with the target host in two ways:
 | 
					
						
							| 
									
										
										
										
											2016-05-20 08:50:56 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2012-05-29 13:33:22 +02:00
										 |  |  | - it executes code (__remote_exec)
 | 
					
						
							|  |  |  | - and it copies files (__remote_copy)
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | By default this is accomplished with ssh and scp respectively.
 | 
					
						
							| 
									
										
										
										
											2016-05-20 08:50:56 +02:00
										 |  |  | The default implementations used by cdist are::
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  |     __remote_exec: ssh -o User=root -q
 | 
					
						
							|  |  |  |     __remote_copy: scp -o User=root -q
 | 
					
						
							| 
									
										
										
										
											2012-05-29 13:33:22 +02:00
										 |  |  | 
 | 
					
						
							|  |  |  | The user can override these defaults by providing custom implementations and
 | 
					
						
							|  |  |  | passing them to cdist with the --remote-exec and/or --remote-copy arguments.
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | For __remote_exec, the custom implementation must behave as if it where ssh.
 | 
					
						
							|  |  |  | For __remote_copy, it must behave like scp.
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | With this simple interface the user can take total control of how cdist
 | 
					
						
							|  |  |  | interacts with the target when required, while the default implementation 
 | 
					
						
							|  |  |  | remains as simple as possible.
 | 
					
						
							| 
									
										
										
										
											2012-05-22 15:10:02 +02:00
										 |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | EXAMPLES
 | 
					
						
							| 
									
										
										
										
											2012-10-31 09:35:08 +01:00
										 |  |  | --------
 | 
					
						
							| 
									
										
										
										
											2012-05-29 13:33:22 +02:00
										 |  |  | See cdist/other/examples/remote/ for some example implementations.
 | 
					
						
							| 
									
										
										
										
											2012-05-22 15:10:02 +02:00
										 |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | SEE ALSO
 | 
					
						
							|  |  |  | --------
 | 
					
						
							| 
									
										
										
										
											2016-05-20 08:50:56 +02:00
										 |  |  | - `cdist(1) <../man1/cdist.html>`_
 | 
					
						
							| 
									
										
										
										
											2012-05-22 15:10:02 +02:00
										 |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | COPYING
 | 
					
						
							|  |  |  | -------
 | 
					
						
							|  |  |  | Copyright \(C) 2011-2012 Nico Schottelius. Free use of this software is
 | 
					
						
							|  |  |  | granted under the terms of the GNU General Public License version 3 (GPLv3).
 |