From d7da92821e8136c5d20d7dae17740282ce27c52d Mon Sep 17 00:00:00 2001
From: Siri Hansen
Date: Wed, 9 Mar 2016 13:07:49 +0100
Subject: Document that any ssh option is allowed in ct_netconfc
The code was changed by OTP-13338, commit
bf309240cb531df880989702ae901316e8b5e97d.
---
lib/common_test/doc/src/ct_netconfc.xml | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
(limited to 'lib/common_test/doc')
diff --git a/lib/common_test/doc/src/ct_netconfc.xml b/lib/common_test/doc/src/ct_netconfc.xml
index 8139d8afdb..d181afbb76 100644
--- a/lib/common_test/doc/src/ct_netconfc.xml
+++ b/lib/common_test/doc/src/ct_netconfc.xml
@@ -201,10 +201,8 @@
information, see module ct.
- host() = hostname() | ip_address()
- -
-
For hostname() and ip_address(), see module
- kernel:inet
+ host() = inet:hostname() | inet:ip_address()
+
key_or_name() = server_id() | target_name()
-
@@ -220,10 +218,13 @@
notification_content() = [event_time() | simple_xml()]
-
- option() = {ssh, host()} | {port, port_number()} | {user, string()} | {password, string()} | {user_dir, string()} | {timeout, timeout()}
+ option() = {ssh, host()} | {port, inet:port_number()} | {timeout, timeout()} | ssh_connect_option()
-
-
For port_number(), see module
- kernel:inet
+ For ssh_connect_option(), see
+ ssh:connect/3,4. Common
+ SSH connect options are user, password
+ and user_dir, but any option that is verified as valid
+ by application SSH is allowed.
options() = [option()]
-
@@ -887,7 +888,7 @@ SessionId, infinity).
ct_netconfc:open/2
instead.
-
The opaque handler() reference returned from this
+
The opaque handle() reference returned from this
function is required as client identifier when calling any other
function in this module.
--
cgit v1.2.3