Repository: incubator-guacamole-manual Updated Branches: refs/heads/master 344b3e8d3 -> 51bd15411
GUACAMOLE-317: Document new "failover_only" column. Project: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/commit/78b7fd0e Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/tree/78b7fd0e Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/diff/78b7fd0e Branch: refs/heads/master Commit: 78b7fd0ed161633379fc2da60f051f0cad1a637a Parents: 344b3e8 Author: Michael Jumper <mjum...@apache.org> Authored: Mon Jun 26 14:52:37 2017 -0700 Committer: Michael Jumper <mjum...@apache.org> Committed: Mon Jun 26 14:52:37 2017 -0700 ---------------------------------------------------------------------- src/chapters/jdbc-auth.xml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/blob/78b7fd0e/src/chapters/jdbc-auth.xml ---------------------------------------------------------------------- diff --git a/src/chapters/jdbc-auth.xml b/src/chapters/jdbc-auth.xml index 63fa74f..6718808 100644 --- a/src/chapters/jdbc-auth.xml +++ b/src/chapters/jdbc-auth.xml @@ -1065,6 +1065,25 @@ INSERT INTO guacamole_user (username, password_salt, password_hash) default weight of <constant>1</constant>.</para> </listitem> </varlistentry> + <varlistentry> + <term><property>failover_only</property></term> + <listitem> + <para>Whether this connection should be used for failover situations only, + also known as a "hot spare". If this column is set to + <constant>TRUE</constant> or <constant>1</constant>, this connection + will be used only when another connection within the same + <type>BALANCING</type> connection group has failed due to an error + within the remote desktop. </para> + <para><emphasis>Connection groups will always transparently switch to the + next available connection in the event of remote desktop failure, + regardless of the value of this column.</emphasis> This column + simply dictates whether a particular connection should be + <emphasis>reserved</emphasis> for such situations, and left unused + otherwise.</para> + <para>This column only has an effect on connections within + <type>BALANCING</type> groups.</para> + </listitem> + </varlistentry> </variablelist> <para>As there are potentially multiple parameters per connection, where the names of each parameter are completely arbitrary and determined only by the protocol in use,
