{"componentChunkName":"component---src-templates-manual-template-tsx","path":"/manuals/client-user/64/starting-broker-debugging.html","webpackCompilationHash":"d1750f6cc413894a8b5c","result":{"data":{"promoBlocks":{"edges":[{"node":{"contentful_id":"47glnSpWzXeFylv2vfQEF8","internal":{"type":"ContentfulPromotionBlock"},"title":{"internal":{"type":"ContentfulHeading"},"contentful_id":"7KIOfSfgwJnCXuvRN6CfrP","textContent":"Standing privileges are a risk with PAM","color":"black","size":"medium"},"subTitle":null,"content":{"nodeType":"document","internal":{"content":"{\"nodeType\":\"document\",\"data\":{},\"content\":[{\"nodeType\":\"paragraph\",\"content\":[{\"nodeType\":\"text\",\"value\":\"Start your journey towards a just-in-time (JIT) model with zero standing privileges (ZSP). Read 'Remove Standing Privileges Through a Just-In-Time PAM Approach' by Gartner , courtesy of SSH.COM.\\n \\n\",\"marks\":[],\"data\":{}}],\"data\":{}}]}"}},"callToAction":{"internal":{"type":"ContentfulButton"},"contentful_id":"19EUesynV2Z7HHcuJk0BAS","content":"Download Gartner research","internalLink":null,"externalLink":"https://info.ssh.com/gartner_research_privileged_access_management","assetLink":null,"anchor":null},"picture":{"internal":{"type":"ContentfulAsset"},"contentful_id":"2ClylmBswcfDx4XdO7NTmL","title":"ICON Gartner ZSP","description":"","file":{"url":"//images.ctfassets.net/0lvk5dbamxpi/2ClylmBswcfDx4XdO7NTmL/78e899153ed66aec3b03b9a2cacd112d/ICON_Gartner_ZSP_ICON_Gartner.png","contentType":"image/png"},"fluid":{"aspectRatio":1,"src":"//images.ctfassets.net/0lvk5dbamxpi/2ClylmBswcfDx4XdO7NTmL/78e899153ed66aec3b03b9a2cacd112d/ICON_Gartner_ZSP_ICON_Gartner.png?w=3000&q=50","srcSet":"//images.ctfassets.net/0lvk5dbamxpi/2ClylmBswcfDx4XdO7NTmL/78e899153ed66aec3b03b9a2cacd112d/ICON_Gartner_ZSP_ICON_Gartner.png?w=750&h=750&q=50 750w,\n//images.ctfassets.net/0lvk5dbamxpi/2ClylmBswcfDx4XdO7NTmL/78e899153ed66aec3b03b9a2cacd112d/ICON_Gartner_ZSP_ICON_Gartner.png?w=1500&h=1500&q=50 1500w,\n//images.ctfassets.net/0lvk5dbamxpi/2ClylmBswcfDx4XdO7NTmL/78e899153ed66aec3b03b9a2cacd112d/ICON_Gartner_ZSP_ICON_Gartner.png?w=1601&h=1601&q=50 1601w","sizes":"(max-width: 3000px) 100vw, 3000px"},"fixed":{"width":3000,"height":3000,"src":"//images.ctfassets.net/0lvk5dbamxpi/2ClylmBswcfDx4XdO7NTmL/78e899153ed66aec3b03b9a2cacd112d/ICON_Gartner_ZSP_ICON_Gartner.png?w=3000&q=50","srcSet":""}},"centered":true,"indentMainContent":null,"transparentBackground":null,"imageScale":70,"imagePadding":null,"name":"WIKI migration side promo block2","product":null,"funnel":null,"topic":null,"keywords":null,"type":null,"priority":null,"globalOverride":null}},{"node":{"contentful_id":"6dfNaA1UlY4bADKQk6awhs","internal":{"type":"ContentfulPromotionBlock"},"title":{"internal":{"type":"ContentfulHeading"},"contentful_id":"49Tb2wSR21P5C2cpcgMZ3","textContent":"Get Multi-cloud PAM software - for free!","color":"black","size":"medium"},"subTitle":null,"content":{"nodeType":"document","internal":{"content":"{\"data\":{},\"content\":[{\"data\":{},\"content\":[{\"data\":{},\"marks\":[],\"value\":\"PrivX® Free replaces your in-house jump hosts and combines your AWS, GCP and Azure access into one multi-cloud solution.\\n \\n\",\"nodeType\":\"text\"}],\"nodeType\":\"paragraph\"}],\"nodeType\":\"document\"}"}},"callToAction":{"internal":{"type":"ContentfulButton"},"contentful_id":"1dmQ13jyyZ46ID07eVNVFb","content":"PrivX Free","internalLink":null,"externalLink":"https://info.ssh.com/privx-free-access-management-software","assetLink":null,"anchor":null},"picture":{"internal":{"type":"ContentfulAsset"},"contentful_id":"4UUYdjING8micwZQur5o6d","title":"ICON computer (search)","description":"","file":{"url":"//images.ctfassets.net/0lvk5dbamxpi/4UUYdjING8micwZQur5o6d/1b378a0f4646075c7a4788f1afffbabe/ICON_computer__search_.svg","contentType":"image/svg+xml"},"fluid":{"aspectRatio":null,"src":null,"srcSet":null,"sizes":null},"fixed":{"width":null,"height":null,"src":null,"srcSet":null}},"centered":true,"indentMainContent":null,"transparentBackground":null,"imageScale":70,"imagePadding":null,"name":"WIKI migration side promo block1","product":null,"funnel":null,"topic":null,"keywords":null,"type":null,"priority":null,"globalOverride":null}}]}},"pageContext":{"isCreatedByStatefulCreatePages":false,"body":"<div bgcolor=\"white\" text=\"black\" link=\"#0000FF\" vlink=\"#840084\" alink=\"#0000FF\"><table width=\"100%\" border=\"0\" cellspacing=\"0\" cellpadding=\"0\" class=\"header\"><tbody><tr><td><a href=\"http://www.ssh.com/\"><img src=\"images/colorbar_blue.png\" alt=\"SSH\" width=\"100%\" height=\"80\" border=\"0\" style=\"position: relative; top:0px;left:0px;\"><img src=\"images/logo_ssh_nega.png\" height=\"40\" border=\"0\" style=\"position: absolute; top:20px;left:55px;\"></a></td></tr></tbody></table><div class=\"navheader\"><table width=\"100%\" summary=\"Navigation header\"><tr><td width=\"40%\" align=\"left\"></td><th width=\"20%\" align=\"center\"></th><td width=\"40%\" align=\"right\"><a accesskey=\"h\" href=\"index.html\"><img src=\"images/home.gif\" alt=\"Home\"></a><a href=\"ix01.html\"><img src=\"images/index.gif\"></a> <a accesskey=\"p\" href=\"trshoot-tool.html\"><img src=\"images/prev.gif\" alt=\"Prev\"></a> <a accesskey=\"u\" href=\"client-cosec-troubleshoot.html\"><img src=\"images/up.gif\" alt=\"Up\"></a> <a accesskey=\"n\" href=\"answers-to-common-problems.html\"><img src=\"images/next.gif\" alt=\"Next\"></a>  </td></tr></table></div><div class=\"sect1\"><div class=\"titlepage\"><div><div><h2 class=\"title\" style=\"clear: both\"><a name=\"starting-broker-debugging\"></a>Setting Connection Broker to Debug Mode</h2></div></div></div><a class=\"indexterm\" name=\"idp5513\"></a><a class=\"indexterm\" name=\"idp5516\"></a><p>The Connection Broker is a component included in Tectia Client. \nThe Connection Broker handles all cryptographic operations and \nauthentication-related tasks for Tectia Client and the command-line \ntools <span class=\"command\"><strong>sshg3, scpg3</strong></span>, and <span class=\"command\"><strong>sftpg3</strong></span>.</p><p>If the verbose level output explained in <a class=\"xref\" href=\"gathering-basic-troubleshooting-information.html\" title=\"Gathering Basic Troubleshooting Information\">Gathering Basic Troubleshooting Information</a> does not solve your problem, set the\n      existing running Broker to debug mode. Existing open connections will remain up and running,\n      which is relevant on multiuser systems or when there are lots of automated scripts running at\n      the same time. You will also get a debug log from new connection attempts.</p><p>To set the Connection Broker to debug mode, follow these instructions:</p><div class=\"orderedlist\"><ol class=\"orderedlist\" type=\"1\"><li class=\"listitem\"><p>Open a shell (on Unix) or command prompt window (on Windows).</p></li><li class=\"listitem\"><p>If you already have an existing Connection Broker, skip this step. If you do not have \nan existing Connection Broker, run the following command:</p><pre class=\"screen\">$ ssh-broker-g3</pre></li><li class=\"listitem\"><p>Set the Connection Broker to debug mode by running the following command:</p><pre class=\"screen\">$ ssh-broker-ctl debug --log-file=<em class=\"replaceable\"><code>&lt;logfile&gt;</code></em> <em class=\"replaceable\"><code>&lt;debug-level&gt;</code></em></pre><p>In the command:</p><div class=\"itemizedlist\"><ul class=\"itemizedlist\" style=\"list-style-type: disc; \"><li class=\"listitem\"><p><code class=\"code\">logfile</code> specifies the file to which the debug \noutput will be directed</p></li><li class=\"listitem\"><p><code class=\"code\">debug-level</code> is an integer from 0 (no debug info) to 99 that \nspecifies the desired amount of debug information.</p><div class=\"note\" style=\"margin-left: 0.5in; margin-right: 0.5in;\"><table border=\"0\" summary=\"Note\"><tr><td rowspan=\"2\" align=\"center\" valign=\"top\" width=\"25\"><img alt=\"[Note]\" src=\"images/note.gif\"></td><th align=\"left\">Note</th></tr><tr><td align=\"left\" valign=\"top\"><p>The recommended debug levels are 1-9. The higher the number, \nthe more detailed the troubleshooting output will be, and the more the \ndebugging will affect performance.</p></td></tr></table></div></li></ul></div><p>On Windows, you can set the debug mode also in the \n<span class=\"command\"><strong>Logs</strong></span> view in the <span class=\"command\"><strong>Tectia Connection Status</strong></span> window. \nTo open the <span class=\"command\"><strong>Tectia Connection Status</strong></span> window, right-click the \n<span class=\"command\"><strong>Tectia</strong></span> icon in the Windows taskbar notification area and \nselect <span class=\"command\"><strong>Status</strong></span>.</p><div class=\"figure\"><a name=\"client-cosec-debug-set\"></a><div class=\"figure-contents\"><div class=\"mediaobject\" align=\"center\"><img src=\"images/client-cosec-debug-set.png\" align=\"middle\" alt=\"Setting the Connection Broker's debug mode on Windows\"></div></div><p class=\"title\"><b>Figure 7.2. Setting the Connection Broker's debug mode on Windows</b></p></div><br class=\"figure-break\"><p>The following example command sets the Connection Broker debug mode to\nlevel 4 and outputs the debug information to a log file named \n<code class=\"code\">broker.log</code>:</p><pre class=\"screen\">$ ssh-broker-ctl debug --log-file=broker.log 4</pre></li><li class=\"listitem\"><p>Connect to a server using one of the clients:</p><pre class=\"screen\">$ sshg3 user@host</pre></li><li class=\"listitem\"><p>View the debug information for the connection in the \n<code class=\"code\">broker.log</code> file.</p></li></ol></div><p>On Unix, you can display the debug output also by using the command \nline tools with argument <code class=\"code\">-D</code>. For example, the following command \nwill display the debug output with a debug level 2:</p><pre class=\"screen\">$ sftpg3 -D2 user@host</pre><p>On Windows, besides the command line tools, you can  display the debug\noutput also in the <span class=\"command\"><strong>Tectia Connection Status</strong></span> window.</p><div class=\"note\" style=\"margin-left: 0.5in; margin-right: 0.5in;\"><table border=\"0\" summary=\"Note\"><tr><td rowspan=\"2\" align=\"center\" valign=\"top\" width=\"25\"><img alt=\"[Note]\" src=\"images/note.gif\"></td><th align=\"left\">Note</th></tr><tr><td align=\"left\" valign=\"top\"><p>After you have collected the debug output, remember to disable \nTectia Client's debug mode, since debugging slows down the performance.</p></td></tr></table></div><p>On Unix and Windows, the debug mode is disabled with the following command:</p><pre class=\"screen\">$ ssh-broker-ctl debug --clear</pre><p>On Windows, the debug mode can be also disabled by setting the debug level back\n  to 0 in the <span class=\"command\"><strong>Tectia Connection Status</strong></span> window, as shown in <a class=\"xref\" href=\"starting-broker-debugging.html#client-cosec-debug\" title=\"Figure 7.3. Disabling the Connection Broker's debug mode on Windows\">Figure 7.3</a></p><div class=\"figure\"><a name=\"client-cosec-debug\"></a><div class=\"figure-contents\"><div class=\"mediaobject\" align=\"center\"><img src=\"images/client-cosec-debug.png\" align=\"middle\" alt=\"Disabling the Connection Broker's debug mode on Windows\"></div></div><p class=\"title\"><b>Figure 7.3. Disabling the Connection Broker's debug mode on Windows</b></p></div><br class=\"figure-break\"></div><div class=\"navfooter\"><table width=\"100%\" summary=\"Navigation footer\"><hr><tr><td width=\"40%\" align=\"left\"></td><th width=\"20%\" align=\"center\"></th><td width=\"40%\" align=\"right\"><a accesskey=\"h\" href=\"index.html\"><img src=\"images/home.gif\" alt=\"Home\"></a><a href=\"ix01.html\"><img src=\"images/index.gif\"></a> <a accesskey=\"p\" href=\"trshoot-tool.html\"><img src=\"images/prev.gif\" alt=\"Prev\"></a> <a accesskey=\"u\" href=\"client-cosec-troubleshoot.html\"><img src=\"images/up.gif\" alt=\"Up\"></a> <a accesskey=\"n\" href=\"answers-to-common-problems.html\"><img src=\"images/next.gif\" alt=\"Next\"></a>  </td></tr></table></div><div class=\"copyrightfooter\" align=\"center\"><p class=\"footer\">\n  Copyright <img src=\"images/copyright.gif\"> 2020 SSH Communications Security Corporation<br>\n  This software is protected by international copyright laws. All rights reserved.<br><a href=\"http://www.ssh.com/about/contact\">Contact Information</a></p></div></div>","head":"<head><meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"><title>Setting Connection Broker to Debug Mode</title><link rel=\"stylesheet\" type=\"text/css\" href=\"sshx.css\"><meta name=\"generator\" content=\"DocBook XSL Stylesheets V1.79.1\"><link rel=\"home\" href=\"index.html\" title=\"Tectia® Client 6.4\"><link rel=\"up\" href=\"client-cosec-troubleshoot.html\" title=\"Chapter 7 Troubleshooting Tectia Client\"><link rel=\"prev\" href=\"trshoot-tool.html\" title=\"Collecting System Information for Troubleshooting\"><link rel=\"next\" href=\"answers-to-common-problems.html\" title=\"Answers to Common Problems\"></head>","url":"/manuals/client-user/64/starting-broker-debugging.html"}}}