161d50be72
Jira-Issue: OSTACKDEV-19
240 lines
20 KiB
HTML
240 lines
20 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
<title>kollacli.api.host — kollacli 1.0.0.dev396 documentation</title>
|
|
|
|
<link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
|
|
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT: '../../../',
|
|
VERSION: '1.0.0.dev396',
|
|
COLLAPSE_INDEX: false,
|
|
FILE_SUFFIX: '.html',
|
|
HAS_SOURCE: true
|
|
};
|
|
</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>
|
|
<link rel="top" title="kollacli 1.0.0.dev396 documentation" href="../../../index.html" />
|
|
<link rel="up" title="Module code" href="../../index.html" />
|
|
</head>
|
|
<body>
|
|
<div class="related">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="../../../genindex.html" title="General Index"
|
|
accesskey="I">index</a></li>
|
|
<li class="right" >
|
|
<a href="../../../py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li><a href="../../../index.html">kollacli 1.0.0.dev396 documentation</a> »</li>
|
|
<li><a href="../../index.html" accesskey="U">Module code</a> »</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body">
|
|
|
|
<h1>Source code for kollacli.api.host</h1><div class="highlight"><pre>
|
|
<span class="c"># Copyright(c) 2016, Oracle and/or its affiliates. All Rights Reserved.</span>
|
|
<span class="c">#</span>
|
|
<span class="c"># Licensed under the Apache License, Version 2.0 (the "License"); you may</span>
|
|
<span class="c"># not use this file except in compliance with the License. You may obtain</span>
|
|
<span class="c"># a copy of the License at</span>
|
|
<span class="c">#</span>
|
|
<span class="c"># http://www.apache.org/licenses/LICENSE-2.0</span>
|
|
<span class="c">#</span>
|
|
<span class="c"># Unless required by applicable law or agreed to in writing, software</span>
|
|
<span class="c"># distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</span>
|
|
<span class="c"># WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the</span>
|
|
<span class="c"># License for the specific language governing permissions and limitations</span>
|
|
<span class="c"># under the License.</span>
|
|
<span class="kn">from</span> <span class="nn">copy</span> <span class="kn">import</span> <span class="n">copy</span>
|
|
<span class="kn">import</span> <span class="nn">kollacli.i18n</span> <span class="kn">as</span> <span class="nn">u</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">kollacli.common.inventory</span> <span class="kn">import</span> <span class="n">Inventory</span>
|
|
<span class="kn">from</span> <span class="nn">kollacli.common.utils</span> <span class="kn">import</span> <span class="n">check_arg</span>
|
|
<span class="kn">from</span> <span class="nn">kollacli.common.utils</span> <span class="kn">import</span> <span class="n">safe_decode</span>
|
|
|
|
|
|
<div class="viewcode-block" id="HostApi"><a class="viewcode-back" href="../../../kollacli.api.html#kollacli.api.host.HostApi">[docs]</a><span class="k">class</span> <span class="nc">HostApi</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
|
|
<div class="viewcode-block" id="HostApi.Host"><a class="viewcode-back" href="../../../kollacli.api.html#kollacli.api.host.HostApi.Host">[docs]</a> <span class="k">class</span> <span class="nc">Host</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
|
|
<span class="sd">"""Host"""</span>
|
|
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">hostname</span><span class="p">,</span> <span class="n">groupnames</span><span class="p">):</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">hostname</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">_groupnames</span> <span class="o">=</span> <span class="n">groupnames</span>
|
|
|
|
<div class="viewcode-block" id="HostApi.Host.get_name"><a class="viewcode-back" href="../../../kollacli.api.html#kollacli.api.host.HostApi.Host.get_name">[docs]</a> <span class="k">def</span> <span class="nf">get_name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""Get name</span>
|
|
|
|
<span class="sd"> :return: host name</span>
|
|
<span class="sd"> :rtype: string</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span>
|
|
</div>
|
|
<div class="viewcode-block" id="HostApi.Host.get_groups"><a class="viewcode-back" href="../../../kollacli.api.html#kollacli.api.host.HostApi.Host.get_groups">[docs]</a> <span class="k">def</span> <span class="nf">get_groups</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""Get names of the groups associated with this host</span>
|
|
|
|
<span class="sd"> :return: group names</span>
|
|
<span class="sd"> :rtype: list of strings</span>
|
|
<span class="sd"> """</span>
|
|
<span class="k">return</span> <span class="n">copy</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_groupnames</span><span class="p">)</span>
|
|
</div></div>
|
|
<div class="viewcode-block" id="HostApi.host_add"><a class="viewcode-back" href="../../../kollacli.api.html#kollacli.api.host.HostApi.host_add">[docs]</a> <span class="k">def</span> <span class="nf">host_add</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">hostnames</span><span class="p">):</span>
|
|
<span class="sd">"""Add hosts to the inventory</span>
|
|
|
|
<span class="sd"> :param hostnames: list of strings</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">check_arg</span><span class="p">(</span><span class="n">hostnames</span><span class="p">,</span> <span class="n">u</span><span class="o">.</span><span class="n">_</span><span class="p">(</span><span class="s">'Host names'</span><span class="p">),</span> <span class="nb">list</span><span class="p">)</span>
|
|
<span class="n">hostnames</span> <span class="o">=</span> <span class="n">safe_decode</span><span class="p">(</span><span class="n">hostnames</span><span class="p">)</span>
|
|
|
|
<span class="n">inventory</span> <span class="o">=</span> <span class="n">Inventory</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
|
|
<span class="n">any_changed</span> <span class="o">=</span> <span class="bp">False</span>
|
|
<span class="k">for</span> <span class="n">hostname</span> <span class="ow">in</span> <span class="n">hostnames</span><span class="p">:</span>
|
|
<span class="n">changed</span> <span class="o">=</span> <span class="n">inventory</span><span class="o">.</span><span class="n">add_host</span><span class="p">(</span><span class="n">hostname</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">changed</span><span class="p">:</span>
|
|
<span class="n">any_changed</span> <span class="o">=</span> <span class="bp">True</span>
|
|
<span class="k">if</span> <span class="n">any_changed</span><span class="p">:</span>
|
|
<span class="n">Inventory</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">inventory</span><span class="p">)</span>
|
|
</div>
|
|
<div class="viewcode-block" id="HostApi.host_remove"><a class="viewcode-back" href="../../../kollacli.api.html#kollacli.api.host.HostApi.host_remove">[docs]</a> <span class="k">def</span> <span class="nf">host_remove</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">hostnames</span><span class="p">):</span>
|
|
<span class="sd">"""Remove hosts from the inventory</span>
|
|
|
|
<span class="sd"> :param hostnames: list of strings</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">check_arg</span><span class="p">(</span><span class="n">hostnames</span><span class="p">,</span> <span class="n">u</span><span class="o">.</span><span class="n">_</span><span class="p">(</span><span class="s">'Host names'</span><span class="p">),</span> <span class="nb">list</span><span class="p">)</span>
|
|
<span class="n">hostnames</span> <span class="o">=</span> <span class="n">safe_decode</span><span class="p">(</span><span class="n">hostnames</span><span class="p">)</span>
|
|
|
|
<span class="n">inventory</span> <span class="o">=</span> <span class="n">Inventory</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
|
|
<span class="n">any_changed</span> <span class="o">=</span> <span class="bp">False</span>
|
|
<span class="k">for</span> <span class="n">hostname</span> <span class="ow">in</span> <span class="n">hostnames</span><span class="p">:</span>
|
|
<span class="n">changed</span> <span class="o">=</span> <span class="n">inventory</span><span class="o">.</span><span class="n">remove_host</span><span class="p">(</span><span class="n">hostname</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="n">changed</span><span class="p">:</span>
|
|
<span class="n">any_changed</span> <span class="o">=</span> <span class="bp">True</span>
|
|
<span class="k">if</span> <span class="n">any_changed</span><span class="p">:</span>
|
|
<span class="n">Inventory</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">inventory</span><span class="p">)</span>
|
|
</div>
|
|
<div class="viewcode-block" id="HostApi.host_get_all"><a class="viewcode-back" href="../../../kollacli.api.html#kollacli.api.host.HostApi.host_get_all">[docs]</a> <span class="k">def</span> <span class="nf">host_get_all</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="sd">"""Get all hosts in the inventory</span>
|
|
|
|
<span class="sd"> :return: Hosts</span>
|
|
<span class="sd"> :rtype: Host</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">inventory</span> <span class="o">=</span> <span class="n">Inventory</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
|
|
<span class="n">hosts</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<span class="n">host_groups</span> <span class="o">=</span> <span class="n">inventory</span><span class="o">.</span><span class="n">get_host_groups</span><span class="p">()</span>
|
|
<span class="k">for</span> <span class="n">hostname</span><span class="p">,</span> <span class="n">groupnames</span> <span class="ow">in</span> <span class="n">host_groups</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
|
|
<span class="n">hosts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">Host</span><span class="p">(</span><span class="n">hostname</span><span class="p">,</span> <span class="n">groupnames</span><span class="p">))</span>
|
|
<span class="k">return</span> <span class="n">hosts</span>
|
|
</div>
|
|
<div class="viewcode-block" id="HostApi.host_get"><a class="viewcode-back" href="../../../kollacli.api.html#kollacli.api.host.HostApi.host_get">[docs]</a> <span class="k">def</span> <span class="nf">host_get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">hostnames</span><span class="p">):</span>
|
|
<span class="sd">"""Get selected hosts in the inventory</span>
|
|
|
|
<span class="sd"> :param hostnames: list of strings</span>
|
|
<span class="sd"> :return: hosts</span>
|
|
<span class="sd"> :rtype: Host</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">check_arg</span><span class="p">(</span><span class="n">hostnames</span><span class="p">,</span> <span class="n">u</span><span class="o">.</span><span class="n">_</span><span class="p">(</span><span class="s">'Host names'</span><span class="p">),</span> <span class="nb">list</span><span class="p">)</span>
|
|
<span class="n">hostnames</span> <span class="o">=</span> <span class="n">safe_decode</span><span class="p">(</span><span class="n">hostnames</span><span class="p">)</span>
|
|
<span class="n">inventory</span> <span class="o">=</span> <span class="n">Inventory</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
|
|
<span class="n">inventory</span><span class="o">.</span><span class="n">validate_hostnames</span><span class="p">(</span><span class="n">hostnames</span><span class="p">)</span>
|
|
|
|
<span class="n">hosts</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<span class="n">host_groups</span> <span class="o">=</span> <span class="n">inventory</span><span class="o">.</span><span class="n">get_host_groups</span><span class="p">()</span>
|
|
<span class="k">for</span> <span class="n">hostname</span> <span class="ow">in</span> <span class="n">hostnames</span><span class="p">:</span>
|
|
<span class="n">hosts</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">Host</span><span class="p">(</span><span class="n">hostname</span><span class="p">,</span> <span class="n">host_groups</span><span class="p">[</span><span class="n">hostname</span><span class="p">]))</span>
|
|
<span class="k">return</span> <span class="n">hosts</span>
|
|
</div>
|
|
<div class="viewcode-block" id="HostApi.host_ssh_check"><a class="viewcode-back" href="../../../kollacli.api.html#kollacli.api.host.HostApi.host_ssh_check">[docs]</a> <span class="k">def</span> <span class="nf">host_ssh_check</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">hostnames</span><span class="p">):</span>
|
|
<span class="sd">"""Check hosts for ssh connectivity</span>
|
|
|
|
<span class="sd"> Check status is a dictionary of form:</span>
|
|
<span class="sd"> - {hostname: {</span>
|
|
<span class="sd"> 'success':<True|False>,</span>
|
|
<span class="sd"> 'msg':message_string},</span>
|
|
<span class="sd"> ...</span>
|
|
<span class="sd"> }</span>
|
|
|
|
<span class="sd"> :param hostnames: list of strings</span>
|
|
<span class="sd"> :return: check status</span>
|
|
<span class="sd"> :rtype: dictionary</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">check_arg</span><span class="p">(</span><span class="n">hostnames</span><span class="p">,</span> <span class="n">u</span><span class="o">.</span><span class="n">_</span><span class="p">(</span><span class="s">'Host names'</span><span class="p">),</span> <span class="nb">list</span><span class="p">)</span>
|
|
<span class="n">inventory</span> <span class="o">=</span> <span class="n">Inventory</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
|
|
<span class="n">hostnames</span> <span class="o">=</span> <span class="n">safe_decode</span><span class="p">(</span><span class="n">hostnames</span><span class="p">)</span>
|
|
<span class="n">inventory</span><span class="o">.</span><span class="n">validate_hostnames</span><span class="p">(</span><span class="n">hostnames</span><span class="p">)</span>
|
|
<span class="n">summary</span> <span class="o">=</span> <span class="n">inventory</span><span class="o">.</span><span class="n">ssh_check_hosts</span><span class="p">(</span><span class="n">hostnames</span><span class="p">)</span>
|
|
<span class="k">return</span> <span class="n">summary</span>
|
|
</div>
|
|
<div class="viewcode-block" id="HostApi.host_setup"><a class="viewcode-back" href="../../../kollacli.api.html#kollacli.api.host.HostApi.host_setup">[docs]</a> <span class="k">def</span> <span class="nf">host_setup</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">hosts_info</span><span class="p">):</span>
|
|
<span class="sd">"""Setup multiple hosts for ssh access</span>
|
|
|
|
<span class="sd"> hosts_info is a dictionary of form:</span>
|
|
<span class="sd"> {hostname': {</span>
|
|
<span class="sd"> 'password': password</span>
|
|
<span class="sd"> 'uname': user_name},</span>
|
|
<span class="sd"> ...</span>
|
|
<span class="sd"> }</span>
|
|
<span class="sd"> The uname entry is optional.</span>
|
|
|
|
<span class="sd"> :param hosts_info: dictionary</span>
|
|
<span class="sd"> """</span>
|
|
<span class="n">check_arg</span><span class="p">(</span><span class="n">hosts_info</span><span class="p">,</span> <span class="n">u</span><span class="o">.</span><span class="n">_</span><span class="p">(</span><span class="s">'Hosts info'</span><span class="p">),</span> <span class="nb">dict</span><span class="p">)</span>
|
|
<span class="n">inventory</span> <span class="o">=</span> <span class="n">Inventory</span><span class="o">.</span><span class="n">load</span><span class="p">()</span>
|
|
<span class="n">inventory</span><span class="o">.</span><span class="n">validate_hostnames</span><span class="p">(</span><span class="n">hosts_info</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span>
|
|
<span class="n">inventory</span><span class="o">.</span><span class="n">setup_hosts</span><span class="p">(</span><span class="n">hosts_info</span><span class="p">)</span></div></div>
|
|
</pre></div>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="sphinxsidebar">
|
|
<div class="sphinxsidebarwrapper">
|
|
<div id="searchbox" style="display: none">
|
|
<h3>Quick search</h3>
|
|
<form class="search" action="../../../search.html" method="get">
|
|
<input type="text" name="q" />
|
|
<input type="submit" value="Go" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
<p class="searchtip" style="font-size: 90%">
|
|
Enter search terms or a module, class or function name.
|
|
</p>
|
|
</div>
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="related">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="../../../genindex.html" title="General Index"
|
|
>index</a></li>
|
|
<li class="right" >
|
|
<a href="../../../py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li><a href="../../../index.html">kollacli 1.0.0.dev396 documentation</a> »</li>
|
|
<li><a href="../../index.html" >Module code</a> »</li>
|
|
</ul>
|
|
</div>
|
|
<div class="footer">
|
|
© Copyright 2016, Oracle.
|
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
|
|
</div>
|
|
</body>
|
|
</html> |