---
layout: docpage

title: "Documentation"

is_homepage: false
is_sphinx_doc: true

doc-title: "snapshot"
doc-header-links: '
  <link rel="top" title="Apache Cassandra Documentation v4.0-alpha3" href="../../index.html"/>
'
doc-search-path: "../../search.html"

extra-footer: '
<script type="text/javascript">
    var DOCUMENTATION_OPTIONS = {
      URL_ROOT:    "",
      VERSION:     "",
      COLLAPSE_INDEX: false,
      FILE_SUFFIX: ".html",
      HAS_SOURCE:  false,
      SOURCELINK_SUFFIX: ".txt"
    };
</script>
'

---
<div class="container-fluid">
  <div class="row">
    <div class="col-md-3">
      <div class="doc-navigation">
        <div class="doc-menu" role="navigation">
          <div class="navbar-header">
            <button type="button" class="pull-left navbar-toggle" data-toggle="collapse" data-target=".sidebar-navbar-collapse">
              <span class="sr-only">Toggle navigation</span>
              <span class="icon-bar"></span>
              <span class="icon-bar"></span>
              <span class="icon-bar"></span>
            </button>
          </div>
          <div class="navbar-collapse collapse sidebar-navbar-collapse">
            <form id="doc-search-form" class="navbar-form" action="../../search.html" method="get" role="search">
              <div class="form-group">
                <input type="text" size="30" class="form-control input-sm" name="q" placeholder="Search docs">
                <input type="hidden" name="check_keywords" value="yes" />
                <input type="hidden" name="area" value="default" />
              </div>
            </form>
            
            
            <ul>
<li class="toctree-l1"><a class="reference internal" href="../../getting_started/index.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../architecture/index.html">Architecture</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../data_modeling/index.html">Data Modeling</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../cql/index.html">The Cassandra Query Language (CQL)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../configuration/index.html">Configuring Cassandra</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../operating/index.html">Operating Cassandra</a></li>
<li class="toctree-l1"><a class="reference internal" href="../index.html">Cassandra Tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../troubleshooting/index.html">Troubleshooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../development/index.html">Contributing to Cassandra</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../faq/index.html">Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../plugins/index.html">Third-Party Plugins</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../contactus.html">Contact us</a></li>
</ul>

            
          </div><!--/.nav-collapse -->
        </div>
      </div>
    </div>
    <div class="col-md-8">
      <div class="content doc-content">
        <div class="content-container">
          
  <div class="section" id="snapshot">
<span id="nodetool-snapshot"></span><h1>snapshot<a class="headerlink" href="#snapshot" title="Permalink to this headline">¶</a></h1>
</div>
<div class="section" id="usage">
<h1>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h1>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">NAME</span>
        <span class="n">nodetool</span> <span class="n">snapshot</span> <span class="o">-</span> <span class="n">Take</span> <span class="n">a</span> <span class="n">snapshot</span> <span class="n">of</span> <span class="n">specified</span> <span class="n">keyspaces</span> <span class="ow">or</span> <span class="n">a</span> <span class="n">snapshot</span>
        <span class="n">of</span> <span class="n">the</span> <span class="n">specified</span> <span class="n">table</span>

<span class="n">SYNOPSIS</span>
        <span class="n">nodetool</span> <span class="p">[(</span><span class="o">-</span><span class="n">h</span> <span class="o">&lt;</span><span class="n">host</span><span class="o">&gt;</span> <span class="o">|</span> <span class="o">--</span><span class="n">host</span> <span class="o">&lt;</span><span class="n">host</span><span class="o">&gt;</span><span class="p">)]</span> <span class="p">[(</span><span class="o">-</span><span class="n">p</span> <span class="o">&lt;</span><span class="n">port</span><span class="o">&gt;</span> <span class="o">|</span> <span class="o">--</span><span class="n">port</span> <span class="o">&lt;</span><span class="n">port</span><span class="o">&gt;</span><span class="p">)]</span>
                <span class="p">[(</span><span class="o">-</span><span class="n">pp</span> <span class="o">|</span> <span class="o">--</span><span class="nb">print</span><span class="o">-</span><span class="n">port</span><span class="p">)]</span> <span class="p">[(</span><span class="o">-</span><span class="n">pw</span> <span class="o">&lt;</span><span class="n">password</span><span class="o">&gt;</span> <span class="o">|</span> <span class="o">--</span><span class="n">password</span> <span class="o">&lt;</span><span class="n">password</span><span class="o">&gt;</span><span class="p">)]</span>
                <span class="p">[(</span><span class="o">-</span><span class="n">pwf</span> <span class="o">&lt;</span><span class="n">passwordFilePath</span><span class="o">&gt;</span> <span class="o">|</span> <span class="o">--</span><span class="n">password</span><span class="o">-</span><span class="n">file</span> <span class="o">&lt;</span><span class="n">passwordFilePath</span><span class="o">&gt;</span><span class="p">)]</span>
                <span class="p">[(</span><span class="o">-</span><span class="n">u</span> <span class="o">&lt;</span><span class="n">username</span><span class="o">&gt;</span> <span class="o">|</span> <span class="o">--</span><span class="n">username</span> <span class="o">&lt;</span><span class="n">username</span><span class="o">&gt;</span><span class="p">)]</span> <span class="n">snapshot</span>
                <span class="p">[(</span><span class="o">-</span><span class="n">cf</span> <span class="o">&lt;</span><span class="n">table</span><span class="o">&gt;</span> <span class="o">|</span> <span class="o">--</span><span class="n">column</span><span class="o">-</span><span class="n">family</span> <span class="o">&lt;</span><span class="n">table</span><span class="o">&gt;</span> <span class="o">|</span> <span class="o">--</span><span class="n">table</span> <span class="o">&lt;</span><span class="n">table</span><span class="o">&gt;</span><span class="p">)]</span>
                <span class="p">[(</span><span class="o">-</span><span class="n">kt</span> <span class="o">&lt;</span><span class="n">ktlist</span><span class="o">&gt;</span> <span class="o">|</span> <span class="o">--</span><span class="n">kt</span><span class="o">-</span><span class="nb">list</span> <span class="o">&lt;</span><span class="n">ktlist</span><span class="o">&gt;</span> <span class="o">|</span> <span class="o">-</span><span class="n">kc</span> <span class="o">&lt;</span><span class="n">ktlist</span><span class="o">&gt;</span> <span class="o">|</span> <span class="o">--</span><span class="n">kc</span><span class="o">.</span><span class="n">list</span> <span class="o">&lt;</span><span class="n">ktlist</span><span class="o">&gt;</span><span class="p">)]</span>
                <span class="p">[(</span><span class="o">-</span><span class="n">sf</span> <span class="o">|</span> <span class="o">--</span><span class="n">skip</span><span class="o">-</span><span class="n">flush</span><span class="p">)]</span> <span class="p">[(</span><span class="o">-</span><span class="n">t</span> <span class="o">&lt;</span><span class="n">tag</span><span class="o">&gt;</span> <span class="o">|</span> <span class="o">--</span><span class="n">tag</span> <span class="o">&lt;</span><span class="n">tag</span><span class="o">&gt;</span><span class="p">)]</span> <span class="p">[</span><span class="o">--</span><span class="p">]</span> <span class="p">[</span><span class="o">&lt;</span><span class="n">keyspaces</span><span class="o">...&gt;</span><span class="p">]</span>

<span class="n">OPTIONS</span>
        <span class="o">-</span><span class="n">cf</span> <span class="o">&lt;</span><span class="n">table</span><span class="o">&gt;</span><span class="p">,</span> <span class="o">--</span><span class="n">column</span><span class="o">-</span><span class="n">family</span> <span class="o">&lt;</span><span class="n">table</span><span class="o">&gt;</span><span class="p">,</span> <span class="o">--</span><span class="n">table</span> <span class="o">&lt;</span><span class="n">table</span><span class="o">&gt;</span>
            <span class="n">The</span> <span class="n">table</span> <span class="n">name</span> <span class="p">(</span><span class="n">you</span> <span class="n">must</span> <span class="n">specify</span> <span class="n">one</span> <span class="ow">and</span> <span class="n">only</span> <span class="n">one</span> <span class="n">keyspace</span> <span class="k">for</span> <span class="n">using</span>
            <span class="n">this</span> <span class="n">option</span><span class="p">)</span>

        <span class="o">-</span><span class="n">h</span> <span class="o">&lt;</span><span class="n">host</span><span class="o">&gt;</span><span class="p">,</span> <span class="o">--</span><span class="n">host</span> <span class="o">&lt;</span><span class="n">host</span><span class="o">&gt;</span>
            <span class="n">Node</span> <span class="n">hostname</span> <span class="ow">or</span> <span class="n">ip</span> <span class="n">address</span>

        <span class="o">-</span><span class="n">kt</span> <span class="o">&lt;</span><span class="n">ktlist</span><span class="o">&gt;</span><span class="p">,</span> <span class="o">--</span><span class="n">kt</span><span class="o">-</span><span class="nb">list</span> <span class="o">&lt;</span><span class="n">ktlist</span><span class="o">&gt;</span><span class="p">,</span> <span class="o">-</span><span class="n">kc</span> <span class="o">&lt;</span><span class="n">ktlist</span><span class="o">&gt;</span><span class="p">,</span> <span class="o">--</span><span class="n">kc</span><span class="o">.</span><span class="n">list</span> <span class="o">&lt;</span><span class="n">ktlist</span><span class="o">&gt;</span>
            <span class="n">The</span> <span class="nb">list</span> <span class="n">of</span> <span class="n">Keyspace</span><span class="o">.</span><span class="n">table</span> <span class="n">to</span> <span class="n">take</span> <span class="n">snapshot</span><span class="o">.</span><span class="p">(</span><span class="n">you</span> <span class="n">must</span> <span class="ow">not</span> <span class="n">specify</span>
            <span class="n">only</span> <span class="n">keyspace</span><span class="p">)</span>

        <span class="o">-</span><span class="n">p</span> <span class="o">&lt;</span><span class="n">port</span><span class="o">&gt;</span><span class="p">,</span> <span class="o">--</span><span class="n">port</span> <span class="o">&lt;</span><span class="n">port</span><span class="o">&gt;</span>
            <span class="n">Remote</span> <span class="n">jmx</span> <span class="n">agent</span> <span class="n">port</span> <span class="n">number</span>

        <span class="o">-</span><span class="n">pp</span><span class="p">,</span> <span class="o">--</span><span class="nb">print</span><span class="o">-</span><span class="n">port</span>
            <span class="n">Operate</span> <span class="ow">in</span> <span class="mf">4.0</span> <span class="n">mode</span> <span class="k">with</span> <span class="n">hosts</span> <span class="n">disambiguated</span> <span class="n">by</span> <span class="n">port</span> <span class="n">number</span>

        <span class="o">-</span><span class="n">pw</span> <span class="o">&lt;</span><span class="n">password</span><span class="o">&gt;</span><span class="p">,</span> <span class="o">--</span><span class="n">password</span> <span class="o">&lt;</span><span class="n">password</span><span class="o">&gt;</span>
            <span class="n">Remote</span> <span class="n">jmx</span> <span class="n">agent</span> <span class="n">password</span>

        <span class="o">-</span><span class="n">pwf</span> <span class="o">&lt;</span><span class="n">passwordFilePath</span><span class="o">&gt;</span><span class="p">,</span> <span class="o">--</span><span class="n">password</span><span class="o">-</span><span class="n">file</span> <span class="o">&lt;</span><span class="n">passwordFilePath</span><span class="o">&gt;</span>
            <span class="n">Path</span> <span class="n">to</span> <span class="n">the</span> <span class="n">JMX</span> <span class="n">password</span> <span class="n">file</span>

        <span class="o">-</span><span class="n">sf</span><span class="p">,</span> <span class="o">--</span><span class="n">skip</span><span class="o">-</span><span class="n">flush</span>
            <span class="n">Do</span> <span class="ow">not</span> <span class="n">flush</span> <span class="n">memtables</span> <span class="n">before</span> <span class="n">snapshotting</span> <span class="p">(</span><span class="n">snapshot</span> <span class="n">will</span> <span class="ow">not</span>
            <span class="n">contain</span> <span class="n">unflushed</span> <span class="n">data</span><span class="p">)</span>

        <span class="o">-</span><span class="n">t</span> <span class="o">&lt;</span><span class="n">tag</span><span class="o">&gt;</span><span class="p">,</span> <span class="o">--</span><span class="n">tag</span> <span class="o">&lt;</span><span class="n">tag</span><span class="o">&gt;</span>
            <span class="n">The</span> <span class="n">name</span> <span class="n">of</span> <span class="n">the</span> <span class="n">snapshot</span>

        <span class="o">-</span><span class="n">u</span> <span class="o">&lt;</span><span class="n">username</span><span class="o">&gt;</span><span class="p">,</span> <span class="o">--</span><span class="n">username</span> <span class="o">&lt;</span><span class="n">username</span><span class="o">&gt;</span>
            <span class="n">Remote</span> <span class="n">jmx</span> <span class="n">agent</span> <span class="n">username</span>

        <span class="o">--</span>
            <span class="n">This</span> <span class="n">option</span> <span class="n">can</span> <span class="n">be</span> <span class="n">used</span> <span class="n">to</span> <span class="n">separate</span> <span class="n">command</span><span class="o">-</span><span class="n">line</span> <span class="n">options</span> <span class="kn">from</span> <span class="nn">the</span>
            <span class="nb">list</span> <span class="n">of</span> <span class="n">argument</span><span class="p">,</span> <span class="p">(</span><span class="n">useful</span> <span class="n">when</span> <span class="n">arguments</span> <span class="n">might</span> <span class="n">be</span> <span class="n">mistaken</span> <span class="k">for</span>
            <span class="n">command</span><span class="o">-</span><span class="n">line</span> <span class="n">options</span>

        <span class="p">[</span><span class="o">&lt;</span><span class="n">keyspaces</span><span class="o">...&gt;</span><span class="p">]</span>
            <span class="n">List</span> <span class="n">of</span> <span class="n">keyspaces</span><span class="o">.</span> <span class="n">By</span> <span class="n">default</span><span class="p">,</span> <span class="nb">all</span> <span class="n">keyspaces</span>


</pre></div>
</div>
</div>


        </div>
      </div>
    </div>
  </div>
</div>