1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
#
# Copyright (C) 2008-2015 CEA/DAM
#
# This file is part of ClusterShell.
#
# ClusterShell is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# ClusterShell is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with ClusterShell; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
"""
ClusterShell Ssh/Scp support
This module implements OpenSSH engine client and task's worker.
"""
import os
# Older versions of shlex can not handle unicode correctly.
# Consider using ushlex instead.
import shlex
from ClusterShell.Worker.Exec import ExecClient, CopyClient, ExecWorker
class SshClient(ExecClient):
"""
Ssh EngineClient.
"""
def _build_cmd(self):
"""
Build the shell command line to start the ssh commmand.
Return an array of command and arguments.
"""
task = self.worker.task
path = task.info("ssh_path") or "ssh"
user = task.info("ssh_user")
options = task.info("ssh_options")
# Build ssh command
cmd_l = [os.path.expanduser(pathc) for pathc in shlex.split(path)]
# Add custom ssh options first as the first obtained value is
# used. Thus all options are overridable by custom options.
if options:
# use expanduser() for options like '-i ~/.ssh/my_id_rsa'
cmd_l += [os.path.expanduser(opt) for opt in shlex.split(options)]
# Hardwired options (overridable by ssh_options)
cmd_l += [ "-a", "-x" ]
if user:
cmd_l.append("-l")
cmd_l.append(user)
connect_timeout = task.info("connect_timeout", 0)
if connect_timeout > 0:
cmd_l.append("-oConnectTimeout=%d" % connect_timeout)
# Disable passphrase/password querying
# When used together with sshpass this must be overwritten
# by a custom option to "-oBatchMode=no".
cmd_l.append("-oBatchMode=yes")
cmd_l.append("%s" % self.key)
cmd_l.append("%s" % self.command)
return (cmd_l, None)
class ScpClient(CopyClient):
"""
Scp EngineClient.
"""
def _build_cmd(self):
"""
Build the shell command line to start the scp commmand.
Return an array of command and arguments.
"""
task = self.worker.task
path = task.info("scp_path") or "scp"
user = task.info("scp_user") or task.info("ssh_user")
# If defined exclusively use scp_options. If no scp_options
# given use ssh_options instead.
options = task.info("scp_options") or task.info("ssh_options")
# Build scp command
cmd_l = [os.path.expanduser(pathc) for pathc in shlex.split(path)]
# Add custom ssh options first as the first obtained value is
# used. Thus all options are overridable by custom options.
if options:
# use expanduser() for options like '-i ~/.ssh/my_id_rsa'
cmd_l += [os.path.expanduser(opt) for opt in shlex.split(options)]
# Hardwired options (overridable by ssh_options)
if self.isdir:
cmd_l.append("-r")
if self.preserve:
cmd_l.append("-p")
connect_timeout = task.info("connect_timeout", 0)
if connect_timeout > 0:
cmd_l.append("-oConnectTimeout=%d" % connect_timeout)
# Disable passphrase/password querying
# When used together with sshpass this must be overwritten
# by a custom option to "-oBatchMode=no".
cmd_l.append("-oBatchMode=yes")
if self.reverse:
if user:
cmd_l.append("%s@%s:%s" % (user, self.key, self.source))
else:
cmd_l.append("%s:%s" % (self.key, self.source))
cmd_l.append(os.path.join(self.dest, "%s.%s" % \
(os.path.basename(self.source), self.key)))
else:
cmd_l.append(self.source)
if user:
cmd_l.append("%s@%s:%s" % (user, self.key, self.dest))
else:
cmd_l.append("%s:%s" % (self.key, self.dest))
return (cmd_l, None)
class WorkerSsh(ExecWorker):
"""
ClusterShell ssh-based worker Class.
Remote Shell (ssh) usage example:
>>> worker = WorkerSsh(nodeset, handler=MyEventHandler(),
... timeout=30, command="/bin/hostname")
>>> task.schedule(worker) # schedule worker for execution
>>> task.resume() # run
Remote Copy (scp) usage example:
>>> worker = WorkerSsh(nodeset, handler=MyEventHandler(),
... timeout=30, source="/etc/my.conf",
... dest="/etc/my.conf")
>>> task.schedule(worker) # schedule worker for execution
>>> task.resume() # run
"""
SHELL_CLASS = SshClient
COPY_CLASS = ScpClient
WORKER_CLASS=WorkerSsh
|
