/usr/share/doc/python-ceilometerclient-doc/html/shell.html is in python-ceilometerclient-doc 2.4.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 | <!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>The ceilometer shell utility — python-ceilometerclient documentation</title>
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/tweaks.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '',
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="python-ceilometerclient documentation" href="index.html" />
<link rel="next" title="The ceilometerclient Python API" href="api.html" />
<link rel="prev" title="Python bindings to the OpenStack Ceilometer API" href="index.html" />
</head>
<body role="document">
<div id="header">
<h1 id="logo"><a href="http://www.openstack.org/">OpenStack</a></h1>
<ul id="navigation">
<li><a href="http://www.openstack.org/" title="Go to the Home page" class="link">Home</a></li>
<li><a href="http://www.openstack.org/projects/" title="Go to the OpenStack Projects page">Projects</a></li>
<li><a href="http://www.openstack.org/user-stories/" title="Go to the User Stories page" class="link">User Stories</a></li>
<li><a href="http://www.openstack.org/community/" title="Go to the Community page" class="link">Community</a></li>
<li><a href="http://www.openstack.org/blog/" title="Go to the OpenStack Blog">Blog</a></li>
<li><a href="http://wiki.openstack.org/" title="Go to the OpenStack Wiki">Wiki</a></li>
<li><a href="http://docs.openstack.org/" title="Go to OpenStack Documentation" class="current">Documentation</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="the-ceilometer-shell-utility">
<h1>The <strong class="program">ceilometer</strong> shell utility<a class="headerlink" href="#the-ceilometer-shell-utility" title="Permalink to this headline">¶</a></h1>
<p>The <strong class="program">ceilometer</strong> shell utility interacts with OpenStack Ceilometer API
from the command line. It supports the entirety of the OpenStack Ceilometer API.</p>
<p>You’ll need to provide <strong class="program">ceilometer</strong> with your OpenStack credentials.
You can do this with the <code class="xref std std-option docutils literal"><span class="pre">--os-username</span></code>, <code class="xref std std-option docutils literal"><span class="pre">--os-password</span></code>,
<code class="xref std std-option docutils literal"><span class="pre">--os-tenant-id</span></code> and <code class="xref std std-option docutils literal"><span class="pre">--os-auth-url</span></code> options, but it’s easier to
just set them as environment variables:</p>
<dl class="envvar">
<dt id="envvar-OS_USERNAME">
<code class="descname">OS_USERNAME</code><a class="headerlink" href="#envvar-OS_USERNAME" title="Permalink to this definition">¶</a></dt>
<dd><p>Your OpenStack username.</p>
</dd></dl>
<dl class="envvar">
<dt id="envvar-OS_PASSWORD">
<code class="descname">OS_PASSWORD</code><a class="headerlink" href="#envvar-OS_PASSWORD" title="Permalink to this definition">¶</a></dt>
<dd><p>Your password.</p>
</dd></dl>
<dl class="envvar">
<dt id="envvar-OS_TENANT_NAME">
<code class="descname">OS_TENANT_NAME</code><a class="headerlink" href="#envvar-OS_TENANT_NAME" title="Permalink to this definition">¶</a></dt>
<dd><p>Project to work on.</p>
</dd></dl>
<dl class="envvar">
<dt id="envvar-OS_AUTH_URL">
<code class="descname">OS_AUTH_URL</code><a class="headerlink" href="#envvar-OS_AUTH_URL" title="Permalink to this definition">¶</a></dt>
<dd><p>The OpenStack auth server URL (keystone).</p>
</dd></dl>
<p>For example, in Bash you would use:</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nb">export</span> <span class="nv">OS_USERNAME</span><span class="o">=</span>user
<span class="nb">export</span> <span class="nv">OS_PASSWORD</span><span class="o">=</span>pass
<span class="nb">export</span> <span class="nv">OS_TENANT_NAME</span><span class="o">=</span>myproject
<span class="nb">export</span> <span class="nv">OS_AUTH_URL</span><span class="o">=</span>http://auth.example.com:5000/v2.0
</pre></div>
</div>
<p>The command line tool will attempt to reauthenticate using your provided credentials
for every request. You can override this behavior by manually supplying an auth
token using <code class="xref std std-option docutils literal"><span class="pre">--os-ceilometer-url</span></code> and <code class="xref std std-option docutils literal"><span class="pre">--os-auth-token</span></code>. You can alternatively
set these environment variables:</p>
<div class="highlight-bash"><div class="highlight"><pre><span class="nb">export</span> <span class="nv">OS_CEILOMETER_URL</span><span class="o">=</span>http://ceilometer.example.org:8777
<span class="nb">export</span> <span class="nv">OS_AUTH_TOKEN</span><span class="o">=</span>3bcc3d3a03f44e3d8377f9247b0ad155
</pre></div>
</div>
<p>From there, all shell commands take the form:</p>
<div class="highlight-bash"><div class="highlight"><pre>ceilometer <command> <span class="o">[</span>arguments...<span class="o">]</span>
</pre></div>
</div>
<p>Run <strong class="program">ceilometer help</strong> to get a full list of all possible commands,
and run <strong class="program">ceilometer help <command></strong> to get detailed help for that
command.</p>
<div class="section" id="v2-client-tips">
<h2>V2 client tips<a class="headerlink" href="#v2-client-tips" title="Permalink to this headline">¶</a></h2>
<p>Use queries to narrow your search (more info at <a class="reference external" href="http://docs.openstack.org/developer/ceilometer/webapi/v2.html#Query">Ceilometer V2 API reference</a>):</p>
<div class="highlight-bash"><div class="highlight"><pre>ceilometer sample-list --meter cpu_util --query <span class="s1">'resource_id=5a301761-f78b-46e2-8900-8b4f6fe6675a'</span> --limit 10
</pre></div>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">The <strong class="program">ceilometer</strong> shell utility</a><ul>
<li><a class="reference internal" href="#v2-client-tips">V2 client tips</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">Python bindings to the OpenStack Ceilometer API</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="api.html"
title="next chapter">The <code class="docutils literal"><span class="pre">ceilometerclient</span></code> Python API</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/shell.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<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" role="navigation" aria-label="related navigation">
<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 class="right" >
<a href="api.html" title="The ceilometerclient Python API"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="Python bindings to the OpenStack Ceilometer API"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">python-ceilometerclient documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright OpenStack Foundation.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6.
</div>
<script type="text/javascript">
try {
//Tracking docs.openstack.org/developer/<projectname> only
//The URL is built from the project variable in conf.py
var pageTracker = _gat._getTracker("UA-17511903-1");
pageTracker._setCookiePath("/developer/python-ceilometerclient");
pageTracker._trackPageview();
} catch(err) {}</script>
</body>
</html>
|