From 051a662cdc5cfc2aa93d86119688c14743837a5f Mon Sep 17 00:00:00 2001
From: Ingela Anderton Andin <ingela@erlang.org>
Date: Tue, 2 Jun 2015 09:14:18 +0200
Subject: ssh: Add profile option

To enable the ssh daemon to run in a virtualized environment, where
there can be more that one server that has the same ip-address
and port, we add a new option profile. The profile name will be
used in concatenation with ip-address and port to identify the
ssh daemon instance.

The name profile was chosen as there is a similar concept in the HTTP client
in inets where profile names can be used to instantiate client configurations.
Also the same type of option has been added to the HTTP server in inets.
---
 lib/ssh/doc/src/ssh.xml | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'lib/ssh/doc/src')

diff --git a/lib/ssh/doc/src/ssh.xml b/lib/ssh/doc/src/ssh.xml
index cf58806aa8..b6533099c8 100644
--- a/lib/ssh/doc/src/ssh.xml
+++ b/lib/ssh/doc/src/ssh.xml
@@ -495,6 +495,19 @@ kex is implicit but public_key is set explicitly.</p>
 	    Can be used to customize the handling of public keys.
 	    </p>
 	  </item>
+	  
+	  <tag><c>{profile, atom()}</c></tag>
+	  <item>
+	    <p>Used together with <c>ip-address</c> and <c>port</c> to
+	    uniquely identify a ssh daemon. This can be useful in a
+	    virtualized environment, where there can be more that one
+	    server that has the same <c>ip-address</c> and
+	    <c>port</c>. If this property is not explicitly set, it is
+	    assumed that the the <c>ip-address</c> and <c>port</c>
+	    uniquely identifies the SSH daemon.
+	    </p>
+	  </item>
+	  
 	  <tag><c><![CDATA[{fd, file_descriptor()}]]></c></tag>
 	  <item>
 	    <p>Allows an existing file-descriptor to be used
-- 
cgit v1.2.3