1ct_ssh(3) Erlang Module Definition ct_ssh(3)
2
6 ct_ssh - SSH/SFTP client module.
7
9 SSH/SFTP client module.
10 This module uses application SSH, which provides detailed information
12 about, for example, functions, types, and options.
13 Argument Server in the SFTP functions is only to be used for SFTP ses‐
15 sions that have been started on existing SSH connections (that is, when
16 the original connection type is ssh). Whenever the connection type is
17 sftp, use the SSH connection reference only.
18 The following options are valid for specifying an SSH/SFTP connection
20 (that is, can be used as configuration elements):
21 [{ConnType, Addr},
23 {port, Port},
24 {user, UserName}
25 {password, Pwd}
26 {user_dir, String}
27 {public_key_alg, PubKeyAlg}
28 {connect_timeout, Timeout}
29 {key_cb, KeyCallbackMod}]
30 ConnType = ssh | sftp.
32 For other types, see ssh(3).
34 All time-out parameters in ct_ssh functions are values in milliseconds.
36
38 connection() = handle() | target_name():
39 For target_name, see module ct.
42 handle() = handle():
44 Handle for a specific SSH/SFTP connection, see module ct.
47 ssh_sftp_return() = term():
49 Return value from an ssh_sftp function.
52
54 apread(SSH, Handle, Position, Length) -> Result
55 Types:
57 SSH = connection()
59 Result = ssh_sftp_return() | {error, Reason}
60 Reason = term()
61 For information and other types, see ssh_sftp(3).
63 apread(SSH, Server, Handle, Position, Length) -> Result
65 Types:
67 SSH = connection()
69 Result = ssh_sftp_return() | {error, Reason}
70 Reason = term()
71 For information and other types, see ssh_sftp(3).
73 apwrite(SSH, Handle, Position, Data) -> Result
75 Types:
77 SSH = connection()
79 Result = ssh_sftp_return() | {error, Reason}
80 Reason = term()
81 For information and other types, see ssh_sftp(3).
83 apwrite(SSH, Server, Handle, Position, Data) -> Result
85 Types:
87 SSH = connection()
89 Result = ssh_sftp_return() | {error, Reason}
90 Reason = term()
91 For information and other types, see ssh_sftp(3).
93 aread(SSH, Handle, Len) -> Result
95 Types:
97 SSH = connection()
99 Result = ssh_sftp_return() | {error, Reason}
100 Reason = term()
101 For information and other types, see ssh_sftp(3).
103 aread(SSH, Server, Handle, Len) -> Result
105 Types:
107 SSH = connection()
109 Result = ssh_sftp_return() | {error, Reason}
110 Reason = term()
111 For information and other types, see ssh_sftp(3).
113 awrite(SSH, Handle, Data) -> Result
115 Types:
117 SSH = connection()
119 Result = ssh_sftp_return() | {error, Reason}
120 Reason = term()
121 For information and other types, see ssh_sftp(3).
123 awrite(SSH, Server, Handle, Data) -> Result
125 Types:
127 SSH = connection()
129 Result = ssh_sftp_return() | {error, Reason}
130 Reason = term()
131 For information and other types, see ssh_sftp(3).
133 close(SSH, Handle) -> Result
135 Types:
137 SSH = connection()
139 Result = ssh_sftp_return() | {error, Reason}
140 Reason = term()
141 For information and other types, see ssh_sftp(3).
143 close(SSH, Server, Handle) -> Result
145 Types:
147 SSH = connection()
149 Result = ssh_sftp_return() | {error, Reason}
150 Reason = term()
151 For information and other types, see ssh_sftp(3).
153 connect(KeyOrName) -> {ok, Handle} | {error, Reason}
155 Equivalent to ct_ssh:connect(KeyOrName, host, []).
157 connect(KeyOrName, ConnType) -> {ok, Handle} | {error, Reason}
159 Equivalent to ct_ssh:connect(KeyOrName, ConnType, []).
161 connect(KeyOrName, ConnType, ExtraOpts) -> {ok, Handle} | {error, Rea‐
163 son}
164 Types:
166 KeyOrName = Key | Name
168 Key = atom()
169 Name = target_name()
170 ConnType = ssh | sftp | host
171 ExtraOpts = ssh_connect_options()
172 Handle = handle()
173 Reason = term()
174 Opens an SSH or SFTP connection using the information associated
176 with KeyOrName.
177 If Name (an alias name for Key) is used to identify the connec‐
179 tion, this name can be used as connection reference for subse‐
180 quent calls. Only one open connection at a time associated with
181 Name is possible. If Key is used, the returned handle must be
182 used for subsequent calls (multiple connections can be opened
183 using the configuration data specified by Key).
184 For information on how to create a new Name, see ct:require/2.
186 For target_name, see module ct.
188 ConnType always overrides the type specified in the address
190 tuple in the configuration data (and in ExtraOpts). So it is
191 possible to, for example, open an SFTP connection directly using
192 data originally specifying an SSH connection. Value host means
193 that the connection type specified by the host option (either in
194 the configuration data or in ExtraOpts) is used.
195 ExtraOpts (optional) are extra SSH options to be added to the
197 configuration data for KeyOrName. The extra options override any
198 existing options with the same key in the configuration data.
199 For details on valid SSH options, see application SSH.
200 del_dir(SSH, Name) -> Result
202 Types:
204 SSH = connection()
206 Result = ssh_sftp_return() | {error, Reason}
207 Reason = term()
208 For information and other types, see ssh_sftp(3).
210 del_dir(SSH, Server, Name) -> Result
212 Types:
214 SSH = connection()
216 Result = ssh_sftp_return() | {error, Reason}
217 Reason = term()
218 For information and other types, see ssh_sftp(3).
220 delete(SSH, Name) -> Result
222 Types:
224 SSH = connection()
226 Result = ssh_sftp_return() | {error, Reason}
227 Reason = term()
228 For information and other types, see ssh_sftp(3).
230 delete(SSH, Server, Name) -> Result
232 Types:
234 SSH = connection()
236 Result = ssh_sftp_return() | {error, Reason}
237 Reason = term()
238 For information and other types, see ssh_sftp(3).
240 disconnect(SSH) -> ok | {error, Reason}
242 Types:
244 SSH = connection()
246 Reason = term()
247 Closes an SSH/SFTP connection.
249 exec(SSH, Command) -> {ok, Data} | {error, Reason}
251 Equivalent to ct_ssh:exec(SSH, Command, DefaultTimeout).
253 exec(SSH, Command, Timeout) -> {ok, Data} | {error, Reason}
255 Types:
257 SSH = connection()
259 Command = string()
260 Timeout = integer()
261 Data = list()
262 Reason = term()
263 Requests server to perform Command. A session channel is opened
265 automatically for the request. Data is received from the server
266 as a result of the command.
267 exec(SSH, ChannelId, Command, Timeout) -> {ok, Data} | {error, Reason}
269 Types:
271 SSH = connection()
273 ChannelId = integer()
274 Command = string()
275 Timeout = integer()
276 Data = list()
277 Reason = term()
278 Requests server to perform Command. A previously opened session
280 channel is used for the request. Data is received from the
281 server as a result of the command.
282 get_file_info(SSH, Handle) -> Result
284 Types:
286 SSH = connection()
288 Result = ssh_sftp_return() | {error, Reason}
289 Reason = term()
290 For information and other types, see ssh_sftp(3).
292 get_file_info(SSH, Server, Handle) -> Result
294 Types:
296 SSH = connection()
298 Result = ssh_sftp_return() | {error, Reason}
299 Reason = term()
300 For information and other types, see ssh_sftp(3).
302 list_dir(SSH, Path) -> Result
304 Types:
306 SSH = connection()
308 Result = ssh_sftp_return() | {error, Reason}
309 Reason = term()
310 For information and other types, see ssh_sftp(3).
312 list_dir(SSH, Server, Path) -> Result
314 Types:
316 SSH = connection()
318 Result = ssh_sftp_return() | {error, Reason}
319 Reason = term()
320 For information and other types, see ssh_sftp(3).
322 make_dir(SSH, Name) -> Result
324 Types:
326 SSH = connection()
328 Result = ssh_sftp_return() | {error, Reason}
329 Reason = term()
330 For information and other types, see ssh_sftp(3).
332 make_dir(SSH, Server, Name) -> Result
334 Types:
336 SSH = connection()
338 Result = ssh_sftp_return() | {error, Reason}
339 Reason = term()
340 For information and other types, see ssh_sftp(3).
342 make_symlink(SSH, Name, Target) -> Result
344 Types:
346 SSH = connection()
348 Result = ssh_sftp_return() | {error, Reason}
349 Reason = term()
350 For information and other types, see ssh_sftp(3).
352 make_symlink(SSH, Server, Name, Target) -> Result
354 Types:
356 SSH = connection()
358 Result = ssh_sftp_return() | {error, Reason}
359 Reason = term()
360 For information and other types, see ssh_sftp(3).
362 open(SSH, File, Mode) -> Result
364 Types:
366 SSH = connection()
368 Result = ssh_sftp_return() | {error, Reason}
369 Reason = term()
370 For information and other types, see ssh_sftp(3).
372 open(SSH, Server, File, Mode) -> Result
374 Types:
376 SSH = connection()
378 Result = ssh_sftp_return() | {error, Reason}
379 Reason = term()
380 For information and other types, see ssh_sftp(3).
382 opendir(SSH, Path) -> Result
384 Types:
386 SSH = connection()
388 Result = ssh_sftp_return() | {error, Reason}
389 Reason = term()
390 For information and other types, see ssh_sftp(3).
392 opendir(SSH, Server, Path) -> Result
394 Types:
396 SSH = connection()
398 Result = ssh_sftp_return() | {error, Reason}
399 Reason = term()
400 For information and other types, see ssh_sftp(3).
402 position(SSH, Handle, Location) -> Result
404 Types:
406 SSH = connection()
408 Result = ssh_sftp_return() | {error, Reason}
409 Reason = term()
410 For information and other types, see ssh_sftp(3).
412 position(SSH, Server, Handle, Location) -> Result
414 Types:
416 SSH = connection()
418 Result = ssh_sftp_return() | {error, Reason}
419 Reason = term()
420 For information and other types, see ssh_sftp(3).
422 pread(SSH, Handle, Position, Length) -> Result
424 Types:
426 SSH = connection()
428 Result = ssh_sftp_return() | {error, Reason}
429 Reason = term()
430 For information and other types, see ssh_sftp(3).
432 pread(SSH, Server, Handle, Position, Length) -> Result
434 Types:
436 SSH = connection()
438 Result = ssh_sftp_return() | {error, Reason}
439 Reason = term()
440 For information and other types, see ssh_sftp(3).
442 pwrite(SSH, Handle, Position, Data) -> Result
444 Types:
446 SSH = connection()
448 Result = ssh_sftp_return() | {error, Reason}
449 Reason = term()
450 For information and other types, see ssh_sftp(3).
452 pwrite(SSH, Server, Handle, Position, Data) -> Result
454 Types:
456 SSH = connection()
458 Result = ssh_sftp_return() | {error, Reason}
459 Reason = term()
460 For information and other types, see ssh_sftp(3).
462 read(SSH, Handle, Len) -> Result
464 Types:
466 SSH = connection()
468 Result = ssh_sftp_return() | {error, Reason}
469 Reason = term()
470 For information and other types, see ssh_sftp(3).
472 read(SSH, Server, Handle, Len) -> Result
474 Types:
476 SSH = connection()
478 Result = ssh_sftp_return() | {error, Reason}
479 Reason = term()
480 For information and other types, see ssh_sftp(3).
482 read_file(SSH, File) -> Result
484 Types:
486 SSH = connection()
488 Result = ssh_sftp_return() | {error, Reason}
489 Reason = term()
490 For information and other types, see ssh_sftp(3).
492 read_file(SSH, Server, File) -> Result
494 Types:
496 SSH = connection()
498 Result = ssh_sftp_return() | {error, Reason}
499 Reason = term()
500 For information and other types, see ssh_sftp(3).
502 read_file_info(SSH, Name) -> Result
504 Types:
506 SSH = connection()
508 Result = ssh_sftp_return() | {error, Reason}
509 Reason = term()
510 For information and other types, see ssh_sftp(3).
512 read_file_info(SSH, Server, Name) -> Result
514 Types:
516 SSH = connection()
518 Result = ssh_sftp_return() | {error, Reason}
519 Reason = term()
520 For information and other types, see ssh_sftp(3).
522 read_link(SSH, Name) -> Result
524 Types:
526 SSH = connection()
528 Result = ssh_sftp_return() | {error, Reason}
529 Reason = term()
530 For information and other types, see ssh_sftp(3).
532 read_link(SSH, Server, Name) -> Result
534 Types:
536 SSH = connection()
538 Result = ssh_sftp_return() | {error, Reason}
539 Reason = term()
540 For information and other types, see ssh_sftp(3).
542 read_link_info(SSH, Name) -> Result
544 Types:
546 SSH = connection()
548 Result = ssh_sftp_return() | {error, Reason}
549 Reason = term()
550 For information and other types, see ssh_sftp(3).
552 read_link_info(SSH, Server, Name) -> Result
554 Types:
556 SSH = connection()
558 Result = ssh_sftp_return() | {error, Reason}
559 Reason = term()
560 For information and other types, see ssh_sftp(3).
562 receive_response(SSH, ChannelId) -> {ok, Data} | {error, Reason}
564 Equivalent to ct_ssh:receive_response(SSH, ChannelId, close).
566 receive_response(SSH, ChannelId, End) -> {ok, Data} | {error, Reason}
568 Equivalent to ct_ssh:receive_response(SSH, ChannelId, End,
570 DefaultTimeout).
571 receive_response(SSH, ChannelId, End, Timeout) -> {ok, Data} | {time‐
573 out, Data} | {error, Reason}
574 Types:
576 SSH = connection()
578 ChannelId = integer()
579 End = Fun | close | timeout
580 Timeout = integer()
581 Data = list()
582 Reason = term()
583 Receives expected data from server on the specified session
585 channel.
586 If End == close, data is returned to the caller when the channel
588 is closed by the server. If a time-out occurs before this hap‐
589 pens, the function returns {timeout,Data} (where Data is the
590 data received so far).
591 If End == timeout, a time-out is expected and {ok,Data} is
593 returned both in the case of a time-out and when the channel is
594 closed.
595 If End is a fun, this fun is called with one argument, the data
597 value in a received ssh_cm message (see ssh_connection(3). The
598 fun is to return either true to end the receiving operation (and
599 have the so far collected data returned) or false to wait for
600 more data from the server. Even if a fun is supplied, the func‐
601 tion returns immediately if the server closes the channel).
602 rename(SSH, OldName, NewName) -> Result
604 Types:
606 SSH = connection()
608 Result = ssh_sftp_return() | {error, Reason}
609 Reason = term()
610 For information and other types, see ssh_sftp(3).
612 rename(SSH, Server, OldName, NewName) -> Result
614 Types:
616 SSH = connection()
618 Result = ssh_sftp_return() | {error, Reason}
619 Reason = term()
620 For information and other types, see ssh_sftp(3).
622 send(SSH, ChannelId, Data) -> ok | {error, Reason}
624 Equivalent to ct_ssh:send(SSH, ChannelId, 0, Data, DefaultTime‐
626 out).
627 send(SSH, ChannelId, Data, Timeout) -> ok | {error, Reason}
629 Equivalent to ct_ssh:send(SSH, ChannelId, 0, Data, Timeout).
631 send(SSH, ChannelId, Type, Data, Timeout) -> ok | {error, Reason}
633 Types:
635 SSH = connection()
637 ChannelId = integer()
638 Type = integer()
639 Data = list()
640 Timeout = integer()
641 Reason = term()
642 Sends data to server on specified session channel.
644 send_and_receive(SSH, ChannelId, Data) -> {ok, Data} | {error, Reason}
646 Equivalent to ct_ssh:send_and_receive(SSH, ChannelId, Data,
648 close).
649 send_and_receive(SSH, ChannelId, Data, End) -> {ok, Data} | {error,
651 Reason}
652 Equivalent to ct_ssh;send_and_receive(SSH, ChannelId, 0, Data,
654 End, DefaultTimeout).
655 send_and_receive(SSH, ChannelId, Data, End, Timeout) -> {ok, Data} |
657 {error, Reason}
658 Equivalent to ct_ssh:send_and_receive(SSH, ChannelId, 0, Data,
660 End, Timeout).
661 send_and_receive(SSH, ChannelId, Type, Data, End, Timeout) -> {ok,
663 Data} | {error, Reason}
664 Types:
666 SSH = connection()
668 ChannelId = integer()
669 Type = integer()
670 Data = list()
671 End = Fun | close | timeout
672 Timeout = integer()
673 Reason = term()
674 Sends data to server on specified session channel and waits to
676 receive the server response.
677 For details on argument End, see ct_ssh:receive_response/4.
679 session_close(SSH, ChannelId) -> ok | {error, Reason}
681 Types:
683 SSH = connection()
685 ChannelId = integer()
686 Reason = term()
687 Closes an SSH session channel.
689 session_open(SSH) -> {ok, ChannelId} | {error, Reason}
691 Equivalent to ct_ssh:session_open(SSH, DefaultTimeout).
693 session_open(SSH, Timeout) -> {ok, ChannelId} | {error, Reason}
695 Types:
697 SSH = connection()
699 Timeout = integer()
700 ChannelId = integer()
701 Reason = term()
702 Opens a channel for an SSH session.
704 sftp_connect(SSH) -> {ok, Server} | {error, Reason}
706 Types:
708 SSH = connection()
710 Server = pid()
711 Reason = term()
712 Starts an SFTP session on an already existing SSH connection.
714 Server identifies the new session and must be specified whenever
715 SFTP requests are to be sent.
716 shell(SSH, ChannelId) -> ok | {error, Reason}
718 Equivalent to ct_ssh:shell(SSH, ChannelId, DefaultTimeout).
720 shell(SSH, ChannelId, Timeout) -> ok | {error, Reason}
722 Types:
724 SSH = connection()
726 ChannelId = integer()
727 Timeout = integer()
728 Reason = term()
729 Requests that the user default shell (typically defined in
731 /etc/passwd in Unix systems) is executed at the server end.
732 subsystem(SSH, ChannelId, Subsystem) -> Status | {error, Reason}
734 Equivalent to ct_ssh:subsystem(SSH, ChannelId, Subsystem,
736 DefaultTimeout).
737 subsystem(SSH, ChannelId, Subsystem, Timeout) -> Status | {error, Rea‐
739 son}
740 Types:
742 SSH = connection()
744 ChannelId = integer()
745 Subsystem = string()
746 Timeout = integer()
747 Status = success | failure
748 Reason = term()
749 Sends a request to execute a predefined subsystem.
751 write(SSH, Handle, Data) -> Result
753 Types:
755 SSH = connection()
757 Result = ssh_sftp_return() | {error, Reason}
758 Reason = term()
759 For information and other types, see ssh_sftp(3).
761 write(SSH, Server, Handle, Data) -> Result
763 Types:
765 SSH = connection()
767 Result = ssh_sftp_return() | {error, Reason}
768 Reason = term()
769 For information and other types, see ssh_sftp(3).
771 write_file(SSH, File, Iolist) -> Result
773 Types:
775 SSH = connection()
777 Result = ssh_sftp_return() | {error, Reason}
778 Reason = term()
779 For information and other types, see ssh_sftp(3).
781 write_file(SSH, Server, File, Iolist) -> Result
783 Types:
785 SSH = connection()
787 Result = ssh_sftp_return() | {error, Reason}
788 Reason = term()
789 For information and other types, see ssh_sftp(3).
791 write_file_info(SSH, Name, Info) -> Result
793 Types:
795 SSH = connection()
797 Result = ssh_sftp_return() | {error, Reason}
798 Reason = term()
799 For information and other types, see ssh_sftp(3).
801 write_file_info(SSH, Server, Name, Info) -> Result
803 Types:
805 SSH = connection()
807 Result = ssh_sftp_return() | {error, Reason}
808 Reason = term()
809 For information and other types, see ssh_sftp(3).
811Ericsson AB common_test 1.17.2 ct_ssh(3)