

<!DOCTYPE html>

<html lang="en-US">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=Edge">

  <link rel="stylesheet" href="/tacctl/assets/css/just-the-docs-default.css">

  <link rel="stylesheet" href="/tacctl/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet">

  <style id="jtd-nav-activation">
  
    .site-nav ul li a {
      background-image: none;
    }

  </style>

  

  
    <script src="/tacctl/assets/js/vendor/lunr.min.js"></script>
  

  <script src="/tacctl/assets/js/just-the-docs.js"></script>

  <meta name="viewport" content="width=device-width, initial-scale=1">

  



  <!-- Begin Jekyll SEO tag v2.9.1 -->
<title>tacctl documentation | Operations documentation for tacctl - TACACS+ and RADIUS access management for network devices and Linux hosts</title>
<meta name="generator" content="Jekyll v4.4.1" />
<meta property="og:title" content="tacctl documentation" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="Operations documentation for tacctl - TACACS+ and RADIUS access management for network devices and Linux hosts" />
<meta name="twitter:description" property="og:description" content="Operations documentation for tacctl - TACACS+ and RADIUS access management for network devices and Linux hosts" />
<link rel="canonical" href="https://rett.github.io/tacctl/assets/css/just-the-docs-head-nav.css" />
<meta property="og:url" content="https://rett.github.io/tacctl/assets/css/just-the-docs-head-nav.css" />
<meta property="og:site_name" content="tacctl documentation" />
<meta property="og:type" content="website" />
<meta name="twitter:card" content="summary" />
<meta name="twitter:title" content="tacctl documentation" />
<meta name="google-site-verification" content="8DQdhimU6MALZvdyDKcIwR6BfC_0esOz3rmz-Rf4uxg" />
<script type="application/ld+json">
{"@context":"https://schema.org","@type":"WebPage","description":"Operations documentation for tacctl - TACACS+ and RADIUS access management for network devices and Linux hosts","headline":"tacctl documentation","url":"https://rett.github.io/tacctl/assets/css/just-the-docs-head-nav.css"}</script>
<!-- End Jekyll SEO tag -->


  <meta name="color-scheme" content="dark light">
<script>
  // Dark is the default stylesheet (and the no-JavaScript view); switch to the
  // light one before the page paints if the reader chose it earlier.
  (function () {
    var theme = null;
    try { theme = localStorage.getItem('tacctl-theme'); } catch (e) {}
    if (theme === 'light') { jtd.setTheme('tacctllight'); }
  })();
</script>


</head>

<body>
  <a class="skip-to-main" href="#main-content">Skip to main content</a>
  <svg xmlns="http://www.w3.org/2000/svg" class="d-none">
  <symbol id="svg-link" viewBox="0 0 24 24">
  <title>Link</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link">
    <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path>
  </svg>
</symbol>

  <symbol id="svg-menu" viewBox="0 0 24 24">
  <title>Menu</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu">
    <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line>
  </svg>
</symbol>

  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
  <title>Expand</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right">
    <polyline points="9 18 15 12 9 6"></polyline>
  </svg>
</symbol>

  <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE -->
<symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link">
  <title id="svg-external-link-title">(external link)</title>
  <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line>
</symbol>

  
    <symbol id="svg-doc" viewBox="0 0 24 24">
  <title>Document</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file">
    <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline>
  </svg>
</symbol>

    <symbol id="svg-search" viewBox="0 0 24 24">
  <title>Search</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search">
    <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line>
  </svg>
</symbol>

  
  
    <!-- Bootstrap Icons. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md -->
<symbol id="svg-copy" viewBox="0 0 16 16">
  <title>Copy</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16">
    <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/>
    <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/>
  </svg>
</symbol>
<symbol id="svg-copied" viewBox="0 0 16 16">
  <title>Copied</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16">
    <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/>
    <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/>
  </svg>
</symbol>

  
</svg>

  
    <header class="side-bar">
  <div class="site-header">
    <a href="/tacctl/" class="site-title lh-tight">
  tacctl documentation

</a>
    <button id="menu-button" class="site-button btn-reset" aria-label="Menu" aria-expanded="false">
      <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg>
    </button>
  </div>

  <nav aria-label="Main" id="site-nav" class="site-nav">
  
  
    <ul class="nav-list"><li class="nav-list-item"><a href="/tacctl/" class="nav-list-link">Home</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Start here submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/tacctl/start-here/" class="nav-list-link">Start here</a><ul class="nav-list"><li class="nav-list-item"><a href="/tacctl/getting-started/" class="nav-list-link">Getting Started</a></li><li class="nav-list-item"><a href="/tacctl/concepts/" class="nav-list-link">Concepts</a></li><li class="nav-list-item"><a href="/tacctl/quick-reference/" class="nav-list-link">Quick Reference</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Guides by role submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/tacctl/guides-by-role/" class="nav-list-link">Guides by role</a><ul class="nav-list"><li class="nav-list-item"><a href="/tacctl/operator-field-guide/" class="nav-list-link">Operator Field Guide</a></li><li class="nav-list-item"><a href="/tacctl/day-to-day-device-operations/" class="nav-list-link">Day-to-Day Device Operations</a></li><li class="nav-list-item"><a href="/tacctl/engineer-guide-device-changes/" class="nav-list-link">Engineer Guide: Device Changes</a></li><li class="nav-list-item"><a href="/tacctl/superuser-daily-operations/" class="nav-list-link">Superuser Daily Operations</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Tasks submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/tacctl/tasks/" class="nav-list-link">Tasks</a><ul class="nav-list"><li class="nav-list-item"><a href="/tacctl/connecting-to-devices/" class="nav-list-link">Connecting to Devices</a></li><li class="nav-list-item"><a href="/tacctl/access-lifecycle/" class="nav-list-link">Access Lifecycle</a></li><li class="nav-list-item"><a href="/tacctl/linux-host-operations/" class="nav-list-link">Linux Host Operations</a></li><li class="nav-list-item"><a href="/tacctl/vendor-notes/" class="nav-list-link">Vendor Notes</a></li><li class="nav-list-item"><a href="/tacctl/backups-and-undo/" class="nav-list-link">Backups and Undo</a></li><li class="nav-list-item"><a href="/tacctl/audit-and-compliance/" class="nav-list-link">Audit and Compliance</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Emergencies and problems submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/tacctl/emergencies-and-problems/" class="nav-list-link">Emergencies and problems</a><ul class="nav-list"><li class="nav-list-item"><a href="/tacctl/troubleshooting/" class="nav-list-link">Troubleshooting</a></li><li class="nav-list-item"><a href="/tacctl/incident-response-runbooks/" class="nav-list-link">Incident Response Runbooks</a></li><li class="nav-list-item"><a href="/tacctl/emergency-lockdown/" class="nav-list-link">Emergency Lockdown</a></li><li class="nav-list-item"><a href="/tacctl/break-glass/" class="nav-list-link">Break Glass</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="Reference submenu" aria-expanded="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/tacctl/reference/" class="nav-list-link">Reference</a><ul class="nav-list"><li class="nav-list-item"><a href="/tacctl/command-reference-map/" class="nav-list-link">Command Reference Map</a></li><li class="nav-list-item"><a href="/tacctl/exit-codes/" class="nav-list-link">Exit Codes</a></li><li class="nav-list-item"><a href="/tacctl/glossary/" class="nav-list-link">Glossary</a></li><li class="nav-list-item"><a href="/tacctl/whats-new-for-operators/" class="nav-list-link">What's New for Operators</a></li></ul></li><li class="nav-list-item"><a href="/tacctl/about-these-docs/" class="nav-list-link">About These Docs</a></li></ul>
  <ul class="nav-list"><li class="nav-list-item external">
          <a href="https://github.com/rett/tacctl/blob/master/docs/install/README.md" class="nav-list-link external"
            
          >
            Install and upgrade
            <svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg>
          </a>
        </li><li class="nav-list-item external">
          <a href="https://github.com/rett/tacctl/blob/master/docs/server/README.md" class="nav-list-link external"
            
          >
            Server
            <svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg>
          </a>
        </li><li class="nav-list-item external">
          <a href="https://github.com/rett/tacctl/blob/master/docs/cli/README.md" class="nav-list-link external"
            
          >
            CLI reference
            <svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg>
          </a>
        </li><li class="nav-list-item external">
          <a href="https://github.com/rett/tacctl/releases" class="nav-list-link external"
            
          >
            Releases
            <svg viewBox="0 0 24 24" aria-labelledby="svg-external-link-title"><use xlink:href="#svg-external-link"></use></svg>
          </a>
        </li></ul>
</nav>


<div class="d-md-block d-none site-footer">
  
  
    This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.
  
  </div>
</header>

  
  <div class="main" id="top">
    <div id="main-header" class="main-header">
  
    

<div class="search" role="search">
  <div class="search-input-wrap">
    <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search tacctl documentation" autocomplete="off">
    <label for="search-input" class="search-label">
      <span class="sr-only">Search tacctl documentation</span>
      <svg viewBox="0 0 24 24" class="search-icon" aria-hidden="true"><use xlink:href="#svg-search"></use></svg>
    </label>
  </div>
  <div id="search-results" class="search-results"></div>
</div>

  
  <button type="button" id="tacctl-theme-toggle" class="tacctl-theme-toggle" hidden>Light theme</button>
<script>
  (function () {
    var button = document.getElementById('tacctl-theme-toggle');
    var theme = 'dark';
    try { if (localStorage.getItem('tacctl-theme') === 'light') { theme = 'light'; } } catch (e) {}
    function label() {
      var other = theme === 'light' ? 'dark' : 'light';
      button.textContent = other === 'light' ? 'Light theme' : 'Dark theme';
      button.setAttribute('aria-label', 'Switch to the ' + other + ' theme');
      button.title = 'Switch to the ' + other + ' theme';
    }
    button.addEventListener('click', function () {
      theme = theme === 'light' ? 'dark' : 'light';
      jtd.setTheme(theme === 'light' ? 'tacctllight' : 'default');
      try { localStorage.setItem('tacctl-theme', theme); } catch (e) {}
      label();
    });
    label();
    button.hidden = false;
  })();
</script>

  
    <nav aria-label="Auxiliary" class="aux-nav">
  <ul class="aux-nav-list">
    
      <li class="aux-nav-list-item">
        <a href="https://github.com/rett/tacctl" class="site-button"
          
        >
          tacctl on GitHub
        </a>
      </li>
    
  </ul>
</nav>

  
</div>

    <div class="main-content-wrap">
      
      <div id="main-content" class="main-content">
        <main>
          
            <h.site-nav ul li a {
  background-image: linear-gradient(-90deg, #16212d 0%, rgba(22, 33, 45, 0.8) 80%, rgba(22, 33, 45, 0) 100%);
}

          

          
            
          
        </main>
        
<hr>
<footer>
  
    <p><a href="#top" id="back-to-top">Back to top</a></p>
  

  <p>Checked against <strong>tacctl 0.2.22</strong> · Reference: the <a href="https://github.com/rett/tacctl/blob/master/docs/README.md">repository docs</a> and <code>man tacctl</code> · tacctl is MIT licensed · <a href="/tacctl/about-these-docs/">About These Docs</a></p><p><a href="https://github.com/rett/tacctl/issues/new?labels=docs-site&amp;title=docs%3A%20&amp;body=Page%3A%20https%3A%2F%2Frett.github.io%2Ftacctl%2Fassets%2Fcss%2Fjust-the-docs-head-nav.css%0ARelease%20of%20tacctl%20you%20run%3A%20%0A%0AWhat%20is%20wrong%20or%20missing%3A%0A">Report a problem with this page</a> (opens a GitHub issue; needs a GitHub account)</p>


  <div class="d-md-none mt-4 fs-2">
    
    
      This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.
    
  </div>
</footer>

      </div>
    </div>
    
      

<div class="search-overlay"></div>

    
  </div>

  
</body>
</html>

