python-hpilo-doc 3.9-1 / usr / share / doc / python-hpilo-doc / html / power.html

This file is indexed.

/usr/share/doc/python-hpilo-doc/html/power.html is in python-hpilo-doc 3.9-1.

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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
<!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>Power manipulation &#8212; python-hpilo 3.9 documentation</title>
    
    <link rel="stylesheet" href="_static/cloud.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Noticia+Text|Open+Sans|Droid+Sans+Mono" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '3.9',
        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>
    <script type="text/javascript" src="_static/cloud.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="top" title="python-hpilo 3.9 documentation" href="index.html" />
    <link rel="next" title="Boot settings and rebooting" href="boot.html" />
    <link rel="prev" title="Server health" href="health.html" /> 
        <meta name="viewport" content="width=device-width, initial-scale=1">
  </head>
  <body role="document">
    <div class="relbar-top">
        
    <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> &nbsp; &nbsp;</li>
        <li class="right" >
          <a href="boot.html" title="Boot settings and rebooting"
             accesskey="N">next</a> &nbsp; &nbsp;</li>
        <li class="right" >
          <a href="health.html" title="Server health"
             accesskey="P">previous</a> &nbsp; &nbsp;</li>
    <li><a href="index.html">python-hpilo 3.9 documentation</a> &#187;</li>
 
      </ul>
    </div>
    </div>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="power-manipulation">
<h1>Power manipulation<a class="headerlink" href="#power-manipulation" title="Permalink to this headline"></a></h1>
<p>The power settings and usage of to the server can be inspected using these
methods. It is also possible to power the server on and off via the iLO, and to
<a class="reference internal" href="boot.html"><span class="doc">boot documentation</span></a>.</p>
<dl class="class">
<dt>
<em class="property">class </em><code class="descclassname">hpilo.</code><code class="descname">Ilo</code></dt>
<dd><dl class="method">
<dt id="hpilo.Ilo.press_pwr_btn">
<code class="descname">press_pwr_btn</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#hpilo.Ilo.press_pwr_btn" title="Permalink to this definition"></a></dt>
<dd><p>Press the power button</p>
</dd></dl>

<dl class="method">
<dt id="hpilo.Ilo.hold_pwr_btn">
<code class="descname">hold_pwr_btn</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#hpilo.Ilo.hold_pwr_btn" title="Permalink to this definition"></a></dt>
<dd><p>Press and hold the power button</p>
</dd></dl>

<dl class="method">
<dt id="hpilo.Ilo.get_host_power_status">
<code class="descname">get_host_power_status</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#hpilo.Ilo.get_host_power_status" title="Permalink to this definition"></a></dt>
<dd><p>Whether the server is powered on or not</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ilo</span><span class="o">.</span><span class="n">get_host_power_status</span><span class="p">()</span>
<span class="go">ON</span>
</pre></div>
</div>
</dd></dl>

<dl class="method">
<dt id="hpilo.Ilo.set_host_power">
<code class="descname">set_host_power</code><span class="sig-paren">(</span><em>host_power=True</em><span class="sig-paren">)</span><a class="headerlink" href="#hpilo.Ilo.set_host_power" title="Permalink to this definition"></a></dt>
<dd><p>Turn host power on or off</p>
</dd></dl>

<dl class="method">
<dt id="hpilo.Ilo.get_server_auto_pwr">
<code class="descname">get_server_auto_pwr</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#hpilo.Ilo.get_server_auto_pwr" title="Permalink to this definition"></a></dt>
<dd><p>Get the automatic power on delay setting</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ilo</span><span class="o">.</span><span class="n">get_server_auto_pwr</span><span class="p">()</span>
<span class="go">ON</span>
</pre></div>
</div>
</dd></dl>

<dl class="method">
<dt id="hpilo.Ilo.set_server_auto_pwr">
<code class="descname">set_server_auto_pwr</code><span class="sig-paren">(</span><em>setting</em><span class="sig-paren">)</span><a class="headerlink" href="#hpilo.Ilo.set_server_auto_pwr" title="Permalink to this definition"></a></dt>
<dd><p>Set the automatic power on delay setting. Valid settings are False,
True (for minumum delay), 15, 30, 45 60 (for that amount of delay)
or random (for a random delay of up to 60 seconds.)</p>
</dd></dl>

<dl class="method">
<dt id="hpilo.Ilo.get_power_readings">
<code class="descname">get_power_readings</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#hpilo.Ilo.get_power_readings" title="Permalink to this definition"></a></dt>
<dd><p>Get current, min, max and average power readings</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ilo</span><span class="o">.</span><span class="n">get_power_readings</span><span class="p">()</span>
<span class="go">{&#39;average_power_reading&#39;: (65, &#39;Watts&#39;),</span>
<span class="go"> &#39;maximum_power_reading&#39;: (101, &#39;Watts&#39;),</span>
<span class="go"> &#39;minimum_power_reading&#39;: (65, &#39;Watts&#39;),</span>
<span class="go"> &#39;present_power_reading&#39;: (67, &#39;Watts&#39;)}</span>
</pre></div>
</div>
</dd></dl>

<dl class="method">
<dt id="hpilo.Ilo.get_server_power_on_time">
<code class="descname">get_server_power_on_time</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#hpilo.Ilo.get_server_power_on_time" title="Permalink to this definition"></a></dt>
<dd><p>How many minutes ago has the server been powered on</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ilo</span><span class="o">.</span><span class="n">get_server_power_on_time</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">pprint</span><span class="p">(</span><span class="n">my_ilo</span><span class="o">.</span><span class="n">get_server_power_on_time</span><span class="p">())</span>
<span class="go">185813</span>
</pre></div>
</div>
</dd></dl>

<dl class="method">
<dt id="hpilo.Ilo.clear_server_power_on_time">
<code class="descname">clear_server_power_on_time</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#hpilo.Ilo.clear_server_power_on_time" title="Permalink to this definition"></a></dt>
<dd><p>Clears the server power on time</p>
</dd></dl>

<dl class="method">
<dt id="hpilo.Ilo.get_host_power_saver_status">
<code class="descname">get_host_power_saver_status</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#hpilo.Ilo.get_host_power_saver_status" title="Permalink to this definition"></a></dt>
<dd><p>Get the configuration of the ProLiant power regulator</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ilo</span><span class="o">.</span><span class="n">get_host_power_saver_status</span><span class="p">()</span>
<span class="go">{&#39;host_power_saver&#39;: &#39;AUTO&#39;}</span>
</pre></div>
</div>
</dd></dl>

<dl class="method">
<dt id="hpilo.Ilo.set_host_power_saver">
<code class="descname">set_host_power_saver</code><span class="sig-paren">(</span><em>host_power_saver</em><span class="sig-paren">)</span><a class="headerlink" href="#hpilo.Ilo.set_host_power_saver" title="Permalink to this definition"></a></dt>
<dd><p>Set the configuration of the ProLiant power regulator</p>
</dd></dl>

<dl class="method">
<dt id="hpilo.Ilo.get_power_cap">
<code class="descname">get_power_cap</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#hpilo.Ilo.get_power_cap" title="Permalink to this definition"></a></dt>
<dd><p>Get the power cap setting</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ilo</span><span class="o">.</span><span class="n">get_power_cap</span><span class="p">()</span>
<span class="go">OFF</span>
</pre></div>
</div>
</dd></dl>

<dl class="method">
<dt id="hpilo.Ilo.set_power_cap">
<code class="descname">set_power_cap</code><span class="sig-paren">(</span><em>power_cap</em><span class="sig-paren">)</span><a class="headerlink" href="#hpilo.Ilo.set_power_cap" title="Permalink to this definition"></a></dt>
<dd><p>Set the power cap feature to a specific value</p>
</dd></dl>

<dl class="method">
<dt id="hpilo.Ilo.get_host_pwr_micro_ver">
<code class="descname">get_host_pwr_micro_ver</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#hpilo.Ilo.get_host_pwr_micro_ver" title="Permalink to this definition"></a></dt>
<dd><p>Get the version of the power micro firmware</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ilo</span><span class="o">.</span><span class="n">get_host_pwr_micro_ver</span><span class="p">()</span>
<span class="go">3.3</span>
</pre></div>
</div>
</dd></dl>

<dl class="method">
<dt id="hpilo.Ilo.get_pwreg">
<code class="descname">get_pwreg</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#hpilo.Ilo.get_pwreg" title="Permalink to this definition"></a></dt>
<dd><p>Get the power and power alert threshold settings</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">ilo</span><span class="o">.</span><span class="n">get_pwreg</span><span class="p">()</span>
<span class="go">{&#39;efficiency_mode&#39;: 3,</span>
<span class="go"> &#39;get_host_power&#39;: {&#39;host_power&#39;: &#39;ON&#39;},</span>
<span class="go"> &#39;pcap&#39;: {&#39;mode&#39;: &#39;OFF&#39;},</span>
<span class="go"> &#39;pwralert&#39;: {&#39;duration&#39;: 0, &#39;threshold&#39;: 0, &#39;type&#39;: &#39;DISABLED&#39;}}</span>
</pre></div>
</div>
</dd></dl>

<dl class="method">
<dt id="hpilo.Ilo.set_pwreg">
<code class="descname">set_pwreg</code><span class="sig-paren">(</span><em>type</em>, <em>threshold=None</em>, <em>duration=None</em><span class="sig-paren">)</span><a class="headerlink" href="#hpilo.Ilo.set_pwreg" title="Permalink to this definition"></a></dt>
<dd><p>Set the power alert threshold</p>
</dd></dl>

</dd></dl>

</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
        <p class="logo"><a href="index.html" title="index">
          <img class="logo" src="_static/python-hpilo.png" alt="Logo"/>
        </a></p>
  <div class="sphinxprev">
    <h4>Previous page</h4>
    <p class="topless"><a href="health.html"
                          title="Previous page">&larr; Server health</a></p>
  </div>
  <div class="sphinxnext">
    <h4>Next page</h4>
    <p class="topless"><a href="boot.html"
                          title="Next page">&rarr; Boot settings and rebooting</a></p>
  </div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
    
    
        <div class="sidebar-toggle-group no-js">
            
            <button class="sidebar-toggle" id="sidebar-hide" title="Hide the sidebar menu">
                 «
                <span class="show-for-small">hide menu</span>
                
            </button>
            <button class="sidebar-toggle" id="sidebar-show" title="Show the sidebar menu">
                
                <span class="show-for-small">menu</span>
                <span class="hide-for-small">sidebar</span>
                 »
            </button>
        </div>
    
      <div class="clearer"></div>
    </div>
    <div class="relbar-bottom">
        
    <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"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> &nbsp; &nbsp;</li>
        <li class="right" >
          <a href="boot.html" title="Boot settings and rebooting"
             >next</a> &nbsp; &nbsp;</li>
        <li class="right" >
          <a href="health.html" title="Server health"
             >previous</a> &nbsp; &nbsp;</li>
    <li><a href="index.html">python-hpilo 3.9 documentation</a> &#187;</li>
 
      </ul>
    </div>
    </div>

    <div class="footer" role="contentinfo">
        &#169; Copyright 2011-2016, Dennis Kaarsemaker.
    </div>
    <!-- cloud_sptheme 1.4 -->
  </body>
</html>

APT Browse - Built by Thomas Orozco.