| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>CLI — ARIA TOSCA 0.1.1 documentation</title> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> |
| |
| |
| |
| |
| |
| <link rel="index" title="Index" |
| href="genindex.html"/> |
| <link rel="search" title="Search" href="search.html"/> |
| <link rel="top" title="ARIA TOSCA 0.1.1 documentation" href="index.html"/> |
| <link rel="next" title="REST" href="rest.html"/> |
| <link rel="prev" title="User Manual for ARIA TOSCA" href="index.html"/> |
| |
| |
| <script src="_static/js/modernizr.min.js"></script> |
| |
| </head> |
| |
| <body class="wy-body-for-nav" role="document"> |
| |
| |
| <div class="wy-grid-for-nav"> |
| |
| |
| <nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| <div class="wy-side-scroll"> |
| <div class="wy-side-nav-search"> |
| |
| |
| |
| <a href="index.html" class="icon icon-home"> ARIA TOSCA |
| |
| |
| |
| </a> |
| |
| |
| |
| |
| <div class="version"> |
| 0.1.1 |
| </div> |
| |
| |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| |
| |
| |
| <ul class="current"> |
| <li class="toctree-l1 current"><a class="current reference internal" href="#">CLI</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="#aria">aria</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#aria-reset">aria reset</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="#aria-plugins">aria plugins</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-plugins-install">install</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-plugins-list">list</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-plugins-show">show</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-plugins-validate">validate</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="#aria-service-templates">aria service_templates</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-service-templates-create-archive">create-archive</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-service-templates-delete">delete</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-service-templates-inputs">inputs</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-service-templates-list">list</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-service-templates-show">show</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-service-templates-store">store</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-service-templates-validate">validate</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="#aria-node-templates">aria node_templates</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-node-templates-list">list</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-node-templates-show">show</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="#aria-services">aria services</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-services-create">create</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-services-delete">delete</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-services-inputs">inputs</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-services-list">list</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-services-outputs">outputs</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-services-show">show</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="#aria-nodes">aria nodes</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-nodes-list">list</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-nodes-show">show</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="#aria-workflows">aria workflows</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-workflows-list">list</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-workflows-show">show</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="#aria-executions">aria executions</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-executions-list">list</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-executions-resume">resume</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-executions-show">show</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-executions-start">start</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="#aria-logs">aria logs</a><ul> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-logs-delete">delete</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="#aria-logs-list">list</a></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference internal" href="rest.html">REST</a></li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="aria.html"><code class="docutils literal"><span class="pre">aria</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.cli.html"><code class="docutils literal"><span class="pre">aria.cli</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.modeling.html"><code class="docutils literal"><span class="pre">aria.modeling</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.modeling.models.html"><code class="docutils literal"><span class="pre">aria.modeling.models</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.html"><code class="docutils literal"><span class="pre">aria.orchestrator</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.context.html"><code class="docutils literal"><span class="pre">aria.orchestrator.context</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.execution_plugin.html"><code class="docutils literal"><span class="pre">aria.orchestrator.execution_plugin</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.execution_plugin.ctx_proxy.html"><code class="docutils literal"><span class="pre">aria.orchestrator.execution_plugin.ctx_proxy</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.execution_plugin.ssh.html"><code class="docutils literal"><span class="pre">aria.orchestrator.execution_plugin.ssh</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.workflows.html"><code class="docutils literal"><span class="pre">aria.orchestrator.workflows</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.workflows.api.html"><code class="docutils literal"><span class="pre">aria.orchestrator.workflows.api</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.workflows.builtin.html"><code class="docutils literal"><span class="pre">aria.orchestrator.workflows.builtin</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.orchestrator.workflows.executor.html"><code class="docutils literal"><span class="pre">aria.orchestrator.workflows.executor</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.parser.html"><code class="docutils literal"><span class="pre">aria.parser</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.parser.consumption.html"><code class="docutils literal"><span class="pre">aria.parser.consumption</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.parser.loading.html"><code class="docutils literal"><span class="pre">aria.parser.loading</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.parser.modeling.html"><code class="docutils literal"><span class="pre">aria.parser.modeling</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.parser.presentation.html"><code class="docutils literal"><span class="pre">aria.parser.presentation</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.parser.reading.html"><code class="docutils literal"><span class="pre">aria.parser.reading</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.parser.validation.html"><code class="docutils literal"><span class="pre">aria.parser.validation</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.storage.html"><code class="docutils literal"><span class="pre">aria.storage</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria.utils.html"><code class="docutils literal"><span class="pre">aria.utils</span></code></a></li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="aria_extension_tosca.simple_v1_0.html"><code class="docutils literal"><span class="pre">aria_extension_tosca.simple_v1_0</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria_extension_tosca.simple_v1_0.modeling.html"><code class="docutils literal"><span class="pre">aria_extension_tosca.simple_v1_0.modeling</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria_extension_tosca.simple_v1_0.presentation.html"><code class="docutils literal"><span class="pre">aria_extension_tosca.simple_v1_0.presentation</span></code></a></li> |
| <li class="toctree-l1"><a class="reference internal" href="aria_extension_tosca.simple_nfv_v1_0.html"><code class="docutils literal"><span class="pre">aria_extension_tosca.simple_nfv_v1_0</span></code></a></li> |
| </ul> |
| |
| |
| |
| </div> |
| </div> |
| </nav> |
| |
| <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| |
| |
| <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> |
| |
| <i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| <a href="index.html">ARIA TOSCA</a> |
| |
| </nav> |
| |
| |
| |
| <div class="wy-nav-content"> |
| <div class="rst-content"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <div role="navigation" aria-label="breadcrumbs navigation"> |
| |
| <ul class="wy-breadcrumbs"> |
| |
| <li><a href="index.html">Docs</a> »</li> |
| |
| <li>CLI</li> |
| |
| |
| <li class="wy-breadcrumbs-aside"> |
| |
| |
| <a href="_sources/cli.rst.txt" rel="nofollow"> View page source</a> |
| |
| |
| </li> |
| |
| </ul> |
| |
| |
| <hr/> |
| </div> |
| <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| <div itemprop="articleBody"> |
| |
| <div class="section" id="cli"> |
| <h1>CLI<a class="headerlink" href="#cli" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="aria"> |
| <h2>aria<a class="headerlink" href="#aria" title="Permalink to this headline">¶</a></h2> |
| <p>ARIA’s Command Line Interface.</p> |
| <p>To activate bash-completion run:</p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="nb">eval</span> <span class="s2">"$(_ARIA_COMPLETE=source aria)"</span> |
| </pre></div> |
| </div> |
| <p>ARIA’s working directory resides by default in “~/.aria”. To change it, set the environment |
| variable ARIA_WORKDIR to something else (e.g. “/tmp/”).</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria <span class="o">[</span>OPTIONS<span class="o">]</span> COMMAND <span class="o">[</span>ARGS<span class="o">]</span>... |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-version"> |
| <code class="descname">--version</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-version" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Display the version and exit</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-reset"> |
| <h2>aria reset<a class="headerlink" href="#aria-reset" title="Permalink to this headline">¶</a></h2> |
| <p>Reset ARIA working directory</p> |
| <p>Deletes installed plugins, service templates, services, executions, and logs. The user |
| configuration will remain intact unless the <cite>–reset_config</cite> flag has been set as well, in |
| which case the entire ARIA working directory shall be removed.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria reset <span class="o">[</span>OPTIONS<span class="o">]</span> |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-reset-f"> |
| <code class="descname">-f</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--force</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-reset-f" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Confirmation for resetting ARIA’s working directory</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-reset-reset-config"> |
| <code class="descname">--reset-config</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-reset-reset-config" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Reset ARIA’s user configuration</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-reset-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-reset-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-plugins"> |
| <h2>aria plugins<a class="headerlink" href="#aria-plugins" title="Permalink to this headline">¶</a></h2> |
| <p>Manage plugins</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria plugins <span class="o">[</span>OPTIONS<span class="o">]</span> COMMAND <span class="o">[</span>ARGS<span class="o">]</span>... |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-plugins-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-plugins-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <div class="section" id="aria-plugins-install"> |
| <h3>install<a class="headerlink" href="#aria-plugins-install" title="Permalink to this headline">¶</a></h3> |
| <p>Install a plugin</p> |
| <p>A valid plugin is a wagon (<cite>http://github.com/cloudify-cosmo/wagon</cite>) in the ZIP format (suffix |
| may also be <cite>.wgn</cite>).</p> |
| <p>PLUGIN_PATH is the path to the wagon archive.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria plugins install <span class="o">[</span>OPTIONS<span class="o">]</span> PLUGIN_PATH |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-plugins-install-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-plugins-install-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-plugins-install-arg-plugin-path"> |
| <code class="descname">PLUGIN_PATH</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-plugins-install-arg-plugin-path" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-plugins-list"> |
| <h3>list<a class="headerlink" href="#aria-plugins-list" title="Permalink to this headline">¶</a></h3> |
| <p>List all installed plugins</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria plugins list <span class="o">[</span>OPTIONS<span class="o">]</span> |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-plugins-list-sort-by"> |
| <code class="descname">--sort-by</code><code class="descclassname"> <sort_by></code><a class="headerlink" href="#cmdoption-aria-plugins-list-sort-by" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Key for sorting the list</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-plugins-list-descending"> |
| <code class="descname">--descending</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-plugins-list-descending" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sort list in descending order [default: False]</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-plugins-list-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-plugins-list-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-plugins-show"> |
| <h3>show<a class="headerlink" href="#aria-plugins-show" title="Permalink to this headline">¶</a></h3> |
| <p>Show information for an installed plugin</p> |
| <p>PLUGIN_ID is the unique installed plugin ID in this ARIA instance.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria plugins show <span class="o">[</span>OPTIONS<span class="o">]</span> PLUGIN_ID |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-plugins-show-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-plugins-show-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-plugins-show-arg-plugin-id"> |
| <code class="descname">PLUGIN_ID</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-plugins-show-arg-plugin-id" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-plugins-validate"> |
| <h3>validate<a class="headerlink" href="#aria-plugins-validate" title="Permalink to this headline">¶</a></h3> |
| <p>Validate a plugin archive</p> |
| <p>A valid plugin is a wagon (<cite>http://github.com/cloudify-cosmo/wagon</cite>) in the ZIP format (suffix |
| may also be <cite>.wgn</cite>).</p> |
| <p>PLUGIN_PATH is the path to the wagon archive.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria plugins validate <span class="o">[</span>OPTIONS<span class="o">]</span> PLUGIN_PATH |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-plugins-validate-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-plugins-validate-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-plugins-validate-arg-plugin-path"> |
| <code class="descname">PLUGIN_PATH</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-plugins-validate-arg-plugin-path" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| </div> |
| </div> |
| <div class="section" id="aria-service-templates"> |
| <h2>aria service_templates<a class="headerlink" href="#aria-service-templates" title="Permalink to this headline">¶</a></h2> |
| <p>Manage service templates</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria service_templates <span class="o">[</span>OPTIONS<span class="o">]</span> COMMAND <span class="o">[</span>ARGS<span class="o">]</span>... |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-service-templates-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <div class="section" id="aria-service-templates-create-archive"> |
| <h3>create-archive<a class="headerlink" href="#aria-service-templates-create-archive" title="Permalink to this headline">¶</a></h3> |
| <p>Create a CSAR archive from a service template source</p> |
| <p>SERVICE_TEMPLATE_PATH is the path to the service template source.</p> |
| <p>DESTINATION is the path to the created CSAR archive.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria service_templates create-archive <span class="o">[</span>OPTIONS<span class="o">]</span> SERVICE_TEMPLATE_PATH |
| DESTINATION |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-create-archive-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-service-templates-create-archive-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-create-archive-arg-service-template-path"> |
| <code class="descname">SERVICE_TEMPLATE_PATH</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-service-templates-create-archive-arg-service-template-path" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-create-archive-arg-destination"> |
| <code class="descname">DESTINATION</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-service-templates-create-archive-arg-destination" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-service-templates-delete"> |
| <h3>delete<a class="headerlink" href="#aria-service-templates-delete" title="Permalink to this headline">¶</a></h3> |
| <p>Delete a stored service template</p> |
| <p>SERVICE_TEMPLATE_NAME is the unique name of the stored service template.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria service_templates delete <span class="o">[</span>OPTIONS<span class="o">]</span> SERVICE_TEMPLATE_NAME |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-delete-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-service-templates-delete-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-delete-arg-service-template-name"> |
| <code class="descname">SERVICE_TEMPLATE_NAME</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-service-templates-delete-arg-service-template-name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-service-templates-inputs"> |
| <h3>inputs<a class="headerlink" href="#aria-service-templates-inputs" title="Permalink to this headline">¶</a></h3> |
| <p>Show stored service template inputs</p> |
| <p>SERVICE_TEMPLATE_NAME is the unique name of the stored service template.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria service_templates inputs <span class="o">[</span>OPTIONS<span class="o">]</span> SERVICE_TEMPLATE_NAME |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-inputs-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-service-templates-inputs-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-inputs-arg-service-template-name"> |
| <code class="descname">SERVICE_TEMPLATE_NAME</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-service-templates-inputs-arg-service-template-name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-service-templates-list"> |
| <h3>list<a class="headerlink" href="#aria-service-templates-list" title="Permalink to this headline">¶</a></h3> |
| <p>List all stored service templates</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria service_templates list <span class="o">[</span>OPTIONS<span class="o">]</span> |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-list-sort-by"> |
| <code class="descname">--sort-by</code><code class="descclassname"> <sort_by></code><a class="headerlink" href="#cmdoption-aria-service-templates-list-sort-by" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Key for sorting the list</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-list-descending"> |
| <code class="descname">--descending</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-service-templates-list-descending" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sort list in descending order [default: False]</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-list-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-service-templates-list-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-service-templates-show"> |
| <h3>show<a class="headerlink" href="#aria-service-templates-show" title="Permalink to this headline">¶</a></h3> |
| <p>Show information for a stored service template</p> |
| <p>SERVICE_TEMPLATE_NAME is the unique name of the stored service template.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria service_templates show <span class="o">[</span>OPTIONS<span class="o">]</span> SERVICE_TEMPLATE_NAME |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-show-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-service-templates-show-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-show-f"> |
| <code class="descname">-f</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--full</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-service-templates-show-f" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show full information. Cannot be used together with -t, –types (only one mode is possible).</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-show-t"> |
| <code class="descname">-t</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--types</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-service-templates-show-t" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show only the type hierarchies. Cannot be used together with -f, –full (only one mode is possible).</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-show-j"> |
| <code class="descname">-j</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--json</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-service-templates-show-j" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show in JSON format (implies –full). Cannot be used together with -y, –yaml (only one format is possible).</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-show-y"> |
| <code class="descname">-y</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--yaml</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-service-templates-show-y" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show in YAML format (implies –full). Cannot be used together with -j, –json (only one format is possible).</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-show-arg-service-template-name"> |
| <code class="descname">SERVICE_TEMPLATE_NAME</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-service-templates-show-arg-service-template-name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-service-templates-store"> |
| <h3>store<a class="headerlink" href="#aria-service-templates-store" title="Permalink to this headline">¶</a></h3> |
| <p>Parse and store a service template archive</p> |
| <p>SERVICE_TEMPLATE_PATH is the path to the service template archive.</p> |
| <p>SERVICE_TEMPLATE_NAME is the unique name to give to the service template in storage.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria service_templates store <span class="o">[</span>OPTIONS<span class="o">]</span> SERVICE_TEMPLATE_PATH |
| SERVICE_TEMPLATE_NAME |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-store-n"> |
| <code class="descname">-n</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--service-template-filename</code><code class="descclassname"> <service_template_filename></code><a class="headerlink" href="#cmdoption-aria-service-templates-store-n" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The name of the archive’s main service template file (only relevant if uploading a non-CSAR archive)</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-store-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-service-templates-store-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-store-arg-service-template-path"> |
| <code class="descname">SERVICE_TEMPLATE_PATH</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-service-templates-store-arg-service-template-path" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-store-arg-service-template-name"> |
| <code class="descname">SERVICE_TEMPLATE_NAME</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-service-templates-store-arg-service-template-name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-service-templates-validate"> |
| <h3>validate<a class="headerlink" href="#aria-service-templates-validate" title="Permalink to this headline">¶</a></h3> |
| <p>Validate a service template archive</p> |
| <p>SERVICE_TEMPLATE_PATH is the path to the service template archive.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria service_templates validate <span class="o">[</span>OPTIONS<span class="o">]</span> SERVICE_TEMPLATE |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-validate-n"> |
| <code class="descname">-n</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--service-template-filename</code><code class="descclassname"> <service_template_filename></code><a class="headerlink" href="#cmdoption-aria-service-templates-validate-n" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The name of the archive’s main service template file (only relevant if uploading a non-CSAR archive)</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-validate-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-service-templates-validate-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-service-templates-validate-arg-service-template"> |
| <code class="descname">SERVICE_TEMPLATE</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-service-templates-validate-arg-service-template" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| </div> |
| </div> |
| <div class="section" id="aria-node-templates"> |
| <h2>aria node_templates<a class="headerlink" href="#aria-node-templates" title="Permalink to this headline">¶</a></h2> |
| <p>Manages stored service templates’ node templates</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria node_templates <span class="o">[</span>OPTIONS<span class="o">]</span> COMMAND <span class="o">[</span>ARGS<span class="o">]</span>... |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-node-templates-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-node-templates-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <div class="section" id="aria-node-templates-list"> |
| <h3>list<a class="headerlink" href="#aria-node-templates-list" title="Permalink to this headline">¶</a></h3> |
| <p>List stored node templates</p> |
| <p>If SERVICE_TEMPLATE_NAME is provided, list node templates for that stored service template. |
| Otherwise, list node templates for all service templates.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria node_templates list <span class="o">[</span>OPTIONS<span class="o">]</span> |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-node-templates-list-t"> |
| <code class="descname">-t</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--service-template-name</code><code class="descclassname"> <service_template_name></code><a class="headerlink" href="#cmdoption-aria-node-templates-list-t" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The unique identifier for the service</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-node-templates-list-sort-by"> |
| <code class="descname">--sort-by</code><code class="descclassname"> <sort_by></code><a class="headerlink" href="#cmdoption-aria-node-templates-list-sort-by" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Key for sorting the list</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-node-templates-list-descending"> |
| <code class="descname">--descending</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-node-templates-list-descending" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sort list in descending order [default: False]</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-node-templates-list-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-node-templates-list-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-node-templates-show"> |
| <h3>show<a class="headerlink" href="#aria-node-templates-show" title="Permalink to this headline">¶</a></h3> |
| <p>Show information for a stored node template</p> |
| <p>NODE_TEMPLATE_ID is the unique node template ID.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria node_templates show <span class="o">[</span>OPTIONS<span class="o">]</span> NODE_TEMPLATE_ID |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-node-templates-show-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-node-templates-show-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-node-templates-show-arg-node-template-id"> |
| <code class="descname">NODE_TEMPLATE_ID</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-node-templates-show-arg-node-template-id" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| </div> |
| </div> |
| <div class="section" id="aria-services"> |
| <h2>aria services<a class="headerlink" href="#aria-services" title="Permalink to this headline">¶</a></h2> |
| <p>Manage services</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria services <span class="o">[</span>OPTIONS<span class="o">]</span> COMMAND <span class="o">[</span>ARGS<span class="o">]</span>... |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-services-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <div class="section" id="aria-services-create"> |
| <h3>create<a class="headerlink" href="#aria-services-create" title="Permalink to this headline">¶</a></h3> |
| <p>Create a service</p> |
| <p>SERVICE_NAME is the unique name to give to the service.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria services create <span class="o">[</span>OPTIONS<span class="o">]</span> <span class="o">[</span>SERVICE_NAME<span class="o">]</span> |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-create-t"> |
| <code class="descname">-t</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--service-template-name</code><code class="descclassname"> <service_template_name></code><a class="headerlink" href="#cmdoption-aria-services-create-t" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The unique identifier for the service [required]</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-create-i"> |
| <code class="descname">-i</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--inputs</code><code class="descclassname"> <inputs></code><a class="headerlink" href="#cmdoption-aria-services-create-i" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Inputs for the service (can be provided as wildcard based paths (“inp?.yaml”, “/my_inputs/”, etc.) to YAML files, a JSON string or as “key1=value1;key2=value2”); this argument can be used multiple times</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-create-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-services-create-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-create-arg-service-name"> |
| <code class="descname">SERVICE_NAME</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-services-create-arg-service-name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Optional argument</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-services-delete"> |
| <h3>delete<a class="headerlink" href="#aria-services-delete" title="Permalink to this headline">¶</a></h3> |
| <p>Delete a service</p> |
| <p>SERVICE_NAME is the unique name of the service.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria services delete <span class="o">[</span>OPTIONS<span class="o">]</span> SERVICE_NAME |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-delete-f"> |
| <code class="descname">-f</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--force</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-services-delete-f" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Delete the service even if it has available nodes</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-delete-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-services-delete-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-delete-arg-service-name"> |
| <code class="descname">SERVICE_NAME</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-services-delete-arg-service-name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-services-inputs"> |
| <h3>inputs<a class="headerlink" href="#aria-services-inputs" title="Permalink to this headline">¶</a></h3> |
| <p>Show service inputs</p> |
| <p>SERVICE_NAME is the unique name of the service.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria services inputs <span class="o">[</span>OPTIONS<span class="o">]</span> SERVICE_NAME |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-inputs-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-services-inputs-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-inputs-arg-service-name"> |
| <code class="descname">SERVICE_NAME</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-services-inputs-arg-service-name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-services-list"> |
| <h3>list<a class="headerlink" href="#aria-services-list" title="Permalink to this headline">¶</a></h3> |
| <p>List services</p> |
| <p>If <cite>–service-template-name</cite> is provided, list services based on that service template. |
| Otherwise, list all services.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria services list <span class="o">[</span>OPTIONS<span class="o">]</span> |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-list-t"> |
| <code class="descname">-t</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--service-template-name</code><code class="descclassname"> <service_template_name></code><a class="headerlink" href="#cmdoption-aria-services-list-t" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The unique identifier for the service</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-list-sort-by"> |
| <code class="descname">--sort-by</code><code class="descclassname"> <sort_by></code><a class="headerlink" href="#cmdoption-aria-services-list-sort-by" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Key for sorting the list</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-list-descending"> |
| <code class="descname">--descending</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-services-list-descending" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sort list in descending order [default: False]</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-list-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-services-list-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-services-outputs"> |
| <h3>outputs<a class="headerlink" href="#aria-services-outputs" title="Permalink to this headline">¶</a></h3> |
| <p>Show service outputs</p> |
| <p>SERVICE_NAME is the unique name of the service.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria services outputs <span class="o">[</span>OPTIONS<span class="o">]</span> SERVICE_NAME |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-outputs-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-services-outputs-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-outputs-arg-service-name"> |
| <code class="descname">SERVICE_NAME</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-services-outputs-arg-service-name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-services-show"> |
| <h3>show<a class="headerlink" href="#aria-services-show" title="Permalink to this headline">¶</a></h3> |
| <p>Show information for a service</p> |
| <p>SERVICE_NAME is the unique name of the service.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria services show <span class="o">[</span>OPTIONS<span class="o">]</span> SERVICE_NAME |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-show-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-services-show-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-show-f"> |
| <code class="descname">-f</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--full</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-services-show-f" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show full information. Cannot be used together with -g, –graph (only one mode is possible).</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-show-g"> |
| <code class="descname">-g</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--graph</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-services-show-g" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show only the node graph. Cannot be used together with -f, –full (only one mode is possible).</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-show-j"> |
| <code class="descname">-j</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--json</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-services-show-j" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show in JSON format (implies –full). Cannot be used together with -y, –yaml (only one format is possible).</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-show-y"> |
| <code class="descname">-y</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--yaml</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-services-show-y" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show in YAML format (implies –full). Cannot be used together with -j, –json (only one format is possible).</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-services-show-arg-service-name"> |
| <code class="descname">SERVICE_NAME</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-services-show-arg-service-name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| </div> |
| </div> |
| <div class="section" id="aria-nodes"> |
| <h2>aria nodes<a class="headerlink" href="#aria-nodes" title="Permalink to this headline">¶</a></h2> |
| <p>Manage services’ nodes</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria nodes <span class="o">[</span>OPTIONS<span class="o">]</span> COMMAND <span class="o">[</span>ARGS<span class="o">]</span>... |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-nodes-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-nodes-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <div class="section" id="aria-nodes-list"> |
| <h3>list<a class="headerlink" href="#aria-nodes-list" title="Permalink to this headline">¶</a></h3> |
| <p>List nodes</p> |
| <p>If SERVICE_NAME is provided, list nodes for that service. Otherwise, list nodes for all |
| services.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria nodes list <span class="o">[</span>OPTIONS<span class="o">]</span> |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-nodes-list-s"> |
| <code class="descname">-s</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--service-name</code><code class="descclassname"> <service_name></code><a class="headerlink" href="#cmdoption-aria-nodes-list-s" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The unique identifier for the service</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-nodes-list-sort-by"> |
| <code class="descname">--sort-by</code><code class="descclassname"> <sort_by></code><a class="headerlink" href="#cmdoption-aria-nodes-list-sort-by" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Key for sorting the list</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-nodes-list-descending"> |
| <code class="descname">--descending</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-nodes-list-descending" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sort list in descending order [default: False]</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-nodes-list-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-nodes-list-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-nodes-show"> |
| <h3>show<a class="headerlink" href="#aria-nodes-show" title="Permalink to this headline">¶</a></h3> |
| <p>Show information for a node</p> |
| <p>NODE_ID is the unique node ID.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria nodes show <span class="o">[</span>OPTIONS<span class="o">]</span> NODE_ID |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-nodes-show-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-nodes-show-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-nodes-show-arg-node-id"> |
| <code class="descname">NODE_ID</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-nodes-show-arg-node-id" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| </div> |
| </div> |
| <div class="section" id="aria-workflows"> |
| <h2>aria workflows<a class="headerlink" href="#aria-workflows" title="Permalink to this headline">¶</a></h2> |
| <p>Manage service workflows</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria workflows <span class="o">[</span>OPTIONS<span class="o">]</span> COMMAND <span class="o">[</span>ARGS<span class="o">]</span>... |
| </pre></div> |
| </div> |
| <div class="section" id="aria-workflows-list"> |
| <h3>list<a class="headerlink" href="#aria-workflows-list" title="Permalink to this headline">¶</a></h3> |
| <p>List service workflows</p> |
| <p>SERVICE_NAME is the unique name of the service.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria workflows list <span class="o">[</span>OPTIONS<span class="o">]</span> |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-workflows-list-s"> |
| <code class="descname">-s</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--service-name</code><code class="descclassname"> <service_name></code><a class="headerlink" href="#cmdoption-aria-workflows-list-s" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The unique identifier for the service [required]</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-workflows-list-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-workflows-list-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-workflows-show"> |
| <h3>show<a class="headerlink" href="#aria-workflows-show" title="Permalink to this headline">¶</a></h3> |
| <p>Show information for a service workflow</p> |
| <p>SERVICE_NAME is the unique name of the service.</p> |
| <p>WORKFLOW_NAME is the unique name of the workflow within the service (e.g. “uninstall”).</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria workflows show <span class="o">[</span>OPTIONS<span class="o">]</span> WORKFLOW_NAME |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-workflows-show-s"> |
| <code class="descname">-s</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--service-name</code><code class="descclassname"> <service_name></code><a class="headerlink" href="#cmdoption-aria-workflows-show-s" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The unique identifier for the service [required]</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-workflows-show-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-workflows-show-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-workflows-show-arg-workflow-name"> |
| <code class="descname">WORKFLOW_NAME</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-workflows-show-arg-workflow-name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| </div> |
| </div> |
| <div class="section" id="aria-executions"> |
| <h2>aria executions<a class="headerlink" href="#aria-executions" title="Permalink to this headline">¶</a></h2> |
| <p>Manage executions</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria executions <span class="o">[</span>OPTIONS<span class="o">]</span> COMMAND <span class="o">[</span>ARGS<span class="o">]</span>... |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-executions-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <div class="section" id="aria-executions-list"> |
| <h3>list<a class="headerlink" href="#aria-executions-list" title="Permalink to this headline">¶</a></h3> |
| <p>List executions</p> |
| <p>If SERVICE_NAME is provided, list executions on that service. Otherwise, list executions on all |
| services.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria executions list <span class="o">[</span>OPTIONS<span class="o">]</span> |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-list-s"> |
| <code class="descname">-s</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--service-name</code><code class="descclassname"> <service_name></code><a class="headerlink" href="#cmdoption-aria-executions-list-s" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The unique identifier for the service</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-list-sort-by"> |
| <code class="descname">--sort-by</code><code class="descclassname"> <sort_by></code><a class="headerlink" href="#cmdoption-aria-executions-list-sort-by" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Key for sorting the list</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-list-descending"> |
| <code class="descname">--descending</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-executions-list-descending" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Sort list in descending order [default: False]</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-list-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-executions-list-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-executions-resume"> |
| <h3>resume<a class="headerlink" href="#aria-executions-resume" title="Permalink to this headline">¶</a></h3> |
| <p>Resume a stopped execution</p> |
| <p>EXECUTION_ID is the unique ID of the execution.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria executions resume <span class="o">[</span>OPTIONS<span class="o">]</span> EXECUTION_ID |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-resume-i"> |
| <code class="descname">-i</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--inputs</code><code class="descclassname"> <inputs></code><a class="headerlink" href="#cmdoption-aria-executions-resume-i" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Inputs for the execution (can be provided as wildcard based paths (“inp?.yaml”, “/my_inputs/”, etc.) to YAML files, a JSON string or as “key1=value1;key2=value2”); this argument can be used multiple times</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-resume-dry"> |
| <code class="descname">--dry</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-executions-resume-dry" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Execute a workflow dry run (prints operations information without causing side effects)</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-resume-task-max-attempts"> |
| <code class="descname">--task-max-attempts</code><code class="descclassname"> <task_max_attempts></code><a class="headerlink" href="#cmdoption-aria-executions-resume-task-max-attempts" title="Permalink to this definition">¶</a></dt> |
| <dd><p>How many times should a task be attempted in case of failures [default: 30]</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-resume-task-retry-interval"> |
| <code class="descname">--task-retry-interval</code><code class="descclassname"> <task_retry_interval></code><a class="headerlink" href="#cmdoption-aria-executions-resume-task-retry-interval" title="Permalink to this definition">¶</a></dt> |
| <dd><p>How long of a minimal interval should occur between task retry attempts [default: 30]</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-resume-m"> |
| <code class="descname">-m</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--mark-pattern</code><code class="descclassname"> <mark_pattern></code><a class="headerlink" href="#cmdoption-aria-executions-resume-m" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Mark a regular expression pattern in the logs</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-resume-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-executions-resume-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-resume-arg-execution-id"> |
| <code class="descname">EXECUTION_ID</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-executions-resume-arg-execution-id" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-executions-show"> |
| <h3>show<a class="headerlink" href="#aria-executions-show" title="Permalink to this headline">¶</a></h3> |
| <p>Show information for an execution</p> |
| <p>EXECUTION_ID is the unique ID of the execution.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria executions show <span class="o">[</span>OPTIONS<span class="o">]</span> EXECUTION_ID |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-show-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-executions-show-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-show-arg-execution-id"> |
| <code class="descname">EXECUTION_ID</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-executions-show-arg-execution-id" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-executions-start"> |
| <h3>start<a class="headerlink" href="#aria-executions-start" title="Permalink to this headline">¶</a></h3> |
| <p>Start a workflow on a service</p> |
| <p>SERVICE_NAME is the unique name of the service.</p> |
| <p>WORKFLOW_NAME is the unique name of the workflow within the service (e.g. “uninstall”).</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria executions start <span class="o">[</span>OPTIONS<span class="o">]</span> WORKFLOW_NAME |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-start-s"> |
| <code class="descname">-s</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--service-name</code><code class="descclassname"> <service_name></code><a class="headerlink" href="#cmdoption-aria-executions-start-s" title="Permalink to this definition">¶</a></dt> |
| <dd><p>The unique identifier for the service [required]</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-start-i"> |
| <code class="descname">-i</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--inputs</code><code class="descclassname"> <inputs></code><a class="headerlink" href="#cmdoption-aria-executions-start-i" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Inputs for the execution (can be provided as wildcard based paths (“inp?.yaml”, “/my_inputs/”, etc.) to YAML files, a JSON string or as “key1=value1;key2=value2”); this argument can be used multiple times</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-start-dry"> |
| <code class="descname">--dry</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-executions-start-dry" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Execute a workflow dry run (prints operations information without causing side effects)</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-start-task-max-attempts"> |
| <code class="descname">--task-max-attempts</code><code class="descclassname"> <task_max_attempts></code><a class="headerlink" href="#cmdoption-aria-executions-start-task-max-attempts" title="Permalink to this definition">¶</a></dt> |
| <dd><p>How many times should a task be attempted in case of failures [default: 30]</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-start-task-retry-interval"> |
| <code class="descname">--task-retry-interval</code><code class="descclassname"> <task_retry_interval></code><a class="headerlink" href="#cmdoption-aria-executions-start-task-retry-interval" title="Permalink to this definition">¶</a></dt> |
| <dd><p>How long of a minimal interval should occur between task retry attempts [default: 30]</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-start-m"> |
| <code class="descname">-m</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--mark-pattern</code><code class="descclassname"> <mark_pattern></code><a class="headerlink" href="#cmdoption-aria-executions-start-m" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Mark a regular expression pattern in the logs</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-start-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-executions-start-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-executions-start-arg-workflow-name"> |
| <code class="descname">WORKFLOW_NAME</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-executions-start-arg-workflow-name" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| </div> |
| </div> |
| <div class="section" id="aria-logs"> |
| <h2>aria logs<a class="headerlink" href="#aria-logs" title="Permalink to this headline">¶</a></h2> |
| <p>Manage logs of workflow executions</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria logs <span class="o">[</span>OPTIONS<span class="o">]</span> COMMAND <span class="o">[</span>ARGS<span class="o">]</span>... |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-logs-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-logs-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <div class="section" id="aria-logs-delete"> |
| <h3>delete<a class="headerlink" href="#aria-logs-delete" title="Permalink to this headline">¶</a></h3> |
| <p>Delete logs of an execution</p> |
| <p>EXECUTION_ID is the unique ID of the execution.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria logs delete <span class="o">[</span>OPTIONS<span class="o">]</span> EXECUTION_ID |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-logs-delete-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-logs-delete-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-logs-delete-arg-execution-id"> |
| <code class="descname">EXECUTION_ID</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-logs-delete-arg-execution-id" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| </div> |
| <div class="section" id="aria-logs-list"> |
| <h3>list<a class="headerlink" href="#aria-logs-list" title="Permalink to this headline">¶</a></h3> |
| <p>List logs for an execution</p> |
| <p>EXECUTION_ID is the unique ID of the execution.</p> |
| <div class="highlight-shell"><div class="highlight"><pre><span></span>aria logs list <span class="o">[</span>OPTIONS<span class="o">]</span> EXECUTION_ID |
| </pre></div> |
| </div> |
| <p class="rubric">Options</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-logs-list-v"> |
| <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-logs-list-v" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Show verbose output; you can supply this up to three times (i.e. -vvv)</p> |
| </dd></dl> |
| |
| <dl class="option"> |
| <dt id="cmdoption-aria-logs-list-m"> |
| <code class="descname">-m</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--mark-pattern</code><code class="descclassname"> <mark_pattern></code><a class="headerlink" href="#cmdoption-aria-logs-list-m" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Mark a regular expression pattern in the logs</p> |
| </dd></dl> |
| |
| <p class="rubric">Arguments</p> |
| <dl class="option"> |
| <dt id="cmdoption-aria-logs-list-arg-execution-id"> |
| <code class="descname">EXECUTION_ID</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-aria-logs-list-arg-execution-id" title="Permalink to this definition">¶</a></dt> |
| <dd><p>Required argument</p> |
| </dd></dl> |
| |
| </div> |
| </div> |
| </div> |
| |
| |
| </div> |
| <div class="articleComments"> |
| |
| </div> |
| </div> |
| <footer> |
| |
| <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> |
| |
| <a href="rest.html" class="btn btn-neutral float-right" title="REST" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a> |
| |
| |
| <a href="index.html" class="btn btn-neutral" title="User Manual for ARIA TOSCA" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a> |
| |
| </div> |
| |
| |
| <hr/> |
| |
| <div role="contentinfo"> |
| <p> |
| © Copyright 2016-2017, Apache Software Foundation. |
| |
| </p> |
| </div> |
| Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. |
| |
| </footer> |
| |
| </div> |
| </div> |
| |
| </section> |
| |
| </div> |
| |
| |
| |
| |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT:'./', |
| VERSION:'0.1.1', |
| COLLAPSE_INDEX:false, |
| FILE_SUFFIX:'.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '.txt' |
| }; |
| </script> |
| <script type="text/javascript" src="_static/jquery.js"></script> |
| <script type="text/javascript" src="_static/underscore.js"></script> |
| <script type="text/javascript" src="_static/doctools.js"></script> |
| |
| |
| |
| |
| |
| <script type="text/javascript" src="_static/js/theme.js"></script> |
| |
| |
| |
| |
| <script type="text/javascript"> |
| jQuery(function () { |
| SphinxRtdTheme.StickyNav.enable(); |
| }); |
| </script> |
| |
| |
| </body> |
| </html> |