cli-docs-beta/index.html


<!DOCTYPE html>

<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>cdp &#8212; CDP CLI 0.9.134 (BETA) documentation</title>
    <link rel="stylesheet" href="static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="static/cdpcli.css" type="text/css" />
    <link rel="stylesheet" type="text/css" href="static/cdpcli.css" />
    
    <script id="documentation_options" data-url_root="./" src="static/documentation_options.js"></script>
    <script src="static/jquery.js"></script>
    <script src="static/underscore.js"></script>
    <script src="static/doctools.js"></script>
    
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="applications" href="applications/index.html" /> 
  </head><body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="applications/index.html" title="applications"
             accesskey="N">next</a></li>
        <li class="nav-item nav-item-0"><a href="#">CDP CLI 0.9.134 (BETA) documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">cdp</a></li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="cdp">
<span id="cli-cdp"></span><h1>cdp<a class="headerlink" href="#cdp" title="Permalink to this headline">¶</a></h1>
<div class="section" id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p>The Cloudera CDP Command Line Interface is a unified tool to manage your CDP services.</p>
</div>
<div class="section" id="synopsis">
<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>cdp <span class="o">[</span>options<span class="o">]</span> &lt;command&gt; &lt;subcommand&gt; <span class="o">[</span>parameters<span class="o">]</span>
</pre></div>
</div>
<p>Use <em>cdp command help</em> for information on a specific command, and <em>cdp command subcommand help</em> for information on a specific subcommand.</p>
</div>
<div class="section" id="options">
<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal notranslate"><span class="pre">--version</span></code> (string)</p>
<p>Display the version of this tool.</p>
<p><code class="docutils literal notranslate"><span class="pre">--debug</span></code> (boolean)</p>
<p>Turn on debug logging.</p>
<p><code class="docutils literal notranslate"><span class="pre">--no-verify-tls</span></code> (boolean)</p>
<p>By default, the CDP CLI uses TLS when communicating with CDP services. For each TLS connection, the CDP CLI will verify TLS certificates. This option overrides the default behavior of verifying TLS certificates.</p>
<p><code class="docutils literal notranslate"><span class="pre">--ca-bundle</span></code> (string)</p>
<p>The CA certificate bundle to use when verifying TLS certificates. Overrides any config and environment settings.</p>
<p><code class="docutils literal notranslate"><span class="pre">--endpoint-url</span></code> (string)</p>
<p>Override command’s default URL with the given URL. This is useful when temporarily calling a different CDP control plane.</p>
<p><code class="docutils literal notranslate"><span class="pre">--form-factor</span></code> (string)</p>
<p>Explicitly specify the form factor of the control plane being called. When not given, the form factor is guessed based on the command’s endpoint URL.</p>
<ul class="simple">
<li><p>public</p></li>
<li><p>private</p></li>
</ul>
<p><code class="docutils literal notranslate"><span class="pre">--output</span></code> (string)</p>
<p>The formatting style for command output.</p>
<ul class="simple">
<li><p>json</p></li>
<li><p>text</p></li>
<li><p>table</p></li>
</ul>
<p><code class="docutils literal notranslate"><span class="pre">--color</span></code> (string)</p>
<p>Turn on/off color output.</p>
<ul class="simple">
<li><p>on</p></li>
<li><p>off</p></li>
<li><p>auto</p></li>
</ul>
<p><code class="docutils literal notranslate"><span class="pre">--cli-read-timeout</span></code> (integer)</p>
<p>The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout.</p>
<p><code class="docutils literal notranslate"><span class="pre">--cli-connect-timeout</span></code> (integer)</p>
<p>The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout.</p>
<p><code class="docutils literal notranslate"><span class="pre">--no-paginate</span></code> (boolean)</p>
<p>Disable automatic pagination.</p>
<p><code class="docutils literal notranslate"><span class="pre">--auth-config</span></code> (string)</p>
<p>Specify the path to the client authentication configuration.</p>
<p><code class="docutils literal notranslate"><span class="pre">--profile</span></code> (string)</p>
<p>Use a specific profile from your credential file.</p>
<p><code class="docutils literal notranslate"><span class="pre">--cdp-region</span></code> (string)</p>
<p>Specifies which CDP region to send this command’s CDP request to.</p>
<ul class="simple">
<li><p>default</p></li>
<li><p>us-west-1</p></li>
<li><p>eu-1</p></li>
<li><p>ap-1</p></li>
<li><p>usg-1</p></li>
</ul>
<p><code class="docutils literal notranslate"><span class="pre">--ensure-ascii</span></code> (boolean)</p>
<p>Escape all non-ASCII characters in the output with uXXXX sequences when the output is in JSON format.</p>
<p><code class="docutils literal notranslate"><span class="pre">--deprecated</span></code> (boolean)</p>
<p>Show deprecated commands and parameters in help message.</p>
<p><code class="docutils literal notranslate"><span class="pre">--no-parameter-expansion</span></code> (boolean)</p>
<p>Disable expanding parameters by referring to files or URIs.</p>
</div>
<div class="section" id="available-commands">
<h2>Available Commands<a class="headerlink" href="#available-commands" title="Permalink to this headline">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="applications/index.html">applications</a></li>
<li class="toctree-l1"><a class="reference internal" href="audit/index.html">audit</a></li>
<li class="toctree-l1"><a class="reference internal" href="cloudprivatelinks/index.html">cloudprivatelinks</a></li>
<li class="toctree-l1"><a class="reference internal" href="compute/index.html">compute</a></li>
<li class="toctree-l1"><a class="reference internal" href="configure/index.html">configure</a></li>
<li class="toctree-l1"><a class="reference internal" href="consumption/index.html">consumption</a></li>
<li class="toctree-l1"><a class="reference internal" href="datacatalog/index.html">datacatalog</a></li>
<li class="toctree-l1"><a class="reference internal" href="datahub/index.html">datahub</a></li>
<li class="toctree-l1"><a class="reference internal" href="datalake/index.html">datalake</a></li>
<li class="toctree-l1"><a class="reference internal" href="de/index.html">de</a></li>
<li class="toctree-l1"><a class="reference internal" href="df/index.html">df</a></li>
<li class="toctree-l1"><a class="reference internal" href="dfworkload/index.html">dfworkload</a></li>
<li class="toctree-l1"><a class="reference internal" href="drscp/index.html">drscp</a></li>
<li class="toctree-l1"><a class="reference internal" href="dw/index.html">dw</a></li>
<li class="toctree-l1"><a class="reference internal" href="environments/index.html">environments</a></li>
<li class="toctree-l1"><a class="reference internal" href="iam/index.html">iam</a></li>
<li class="toctree-l1"><a class="reference internal" href="imagecatalog/index.html">imagecatalog</a></li>
<li class="toctree-l1"><a class="reference internal" href="login/index.html">login</a></li>
<li class="toctree-l1"><a class="reference internal" href="logout/index.html">logout</a></li>
<li class="toctree-l1"><a class="reference internal" href="metrics/index.html">metrics</a></li>
<li class="toctree-l1"><a class="reference internal" href="ml/index.html">ml</a></li>
<li class="toctree-l1"><a class="reference internal" href="opdb/index.html">opdb</a></li>
<li class="toctree-l1"><a class="reference internal" href="refdoc/index.html">refdoc</a></li>
<li class="toctree-l1"><a class="reference internal" href="replicationmanager/index.html">replicationmanager</a></li>
</ul>
</div>
</div>
</div>


            <div class="clearer"></div>
          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="#">Table of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">cdp</a><ul>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#synopsis">Synopsis</a></li>
<li><a class="reference internal" href="#options">Options</a></li>
<li><a class="reference internal" href="#available-commands">Available Commands</a></li>
</ul>
</li>
</ul>

  <h4>Next topic</h4>
  <p class="topless"><a href="applications/index.html"
                        title="next chapter">applications</a></p>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="applications/index.html" title="applications"
             >next</a></li>
        <li class="nav-item nav-item-0"><a href="#">CDP CLI 0.9.134 (BETA) documentation</a> &#187;</li>
        <li class="nav-item nav-item-this"><a href="">cdp</a></li> 
      </ul>
    </div>
    <div class="footer" role="contentinfo">
        &#169; Copyright 2025, Cloudera, Inc..
      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.2.
    </div>
  </body>
</html>