<!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" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
Class: ForemanApi::Resources::Host
— Documentation by YARD 0.8.7
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../../';
framesUrl = "../../frames.html#!" + escape(window.location.href);
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (H)</a> »
<span class='title'><span class='object_link'><a href="../../ForemanApi.html" title="ForemanApi (module)">ForemanApi</a></span></span> » <span class='title'><span class='object_link'><a href="../Resources.html" title="ForemanApi::Resources (module)">Resources</a></span></span>
»
<span class="title">Host</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
Class List
</a>
<a class="full_list_link" id="method_list_link"
href="../../method_list.html">
Method List
</a>
<a class="full_list_link" id="file_list_link"
href="../../file_list.html">
File List
</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Class: ForemanApi::Resources::Host
</h1>
<dl class="box">
<dt class="r1">Inherits:</dt>
<dd class="r1">
<span class="inheritName">Base</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Base</li>
<li class="next">ForemanApi::Resources::Host</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/foreman_api/resources/host.rb</dd>
</dl>
<div class="clear"></div>
<h2>
Class Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#doc-class_method" title="doc (class method)">+ (Object) <strong>doc</strong> </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#boot-instance_method" title="#boot (instance method)">- (Array) <strong>boot</strong>(params = {}, headers = {}) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>First item: parsed data; second item: raw body.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#create-instance_method" title="#create (instance method)">- (Array) <strong>create</strong>(params = {}, headers = {}) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>First item: parsed data; second item: raw body.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#destroy-instance_method" title="#destroy (instance method)">- (Array) <strong>destroy</strong>(params = {}, headers = {}) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>First item: parsed data; second item: raw body.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#facts-instance_method" title="#facts (instance method)">- (Array) <strong>facts</strong>(params = {}, headers = {}) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>First item: parsed data; second item: raw body.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#index-instance_method" title="#index (instance method)">- (Array) <strong>index</strong>(params = {}, headers = {}) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>First item: parsed data; second item: raw body.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#power-instance_method" title="#power (instance method)">- (Array) <strong>power</strong>(params = {}, headers = {}) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>First item: parsed data; second item: raw body.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#puppetrun-instance_method" title="#puppetrun (instance method)">- (Array) <strong>puppetrun</strong>(params = {}, headers = {}) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>First item: parsed data; second item: raw body.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#show-instance_method" title="#show (instance method)">- (Array) <strong>show</strong>(params = {}, headers = {}) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>First item: parsed data; second item: raw body.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#status-instance_method" title="#status (instance method)">- (Array) <strong>status</strong>(params = {}, headers = {}) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>First item: parsed data; second item: raw body.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#update-instance_method" title="#update (instance method)">- (Array) <strong>update</strong>(params = {}, headers = {}) </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>First item: parsed data; second item: raw body.</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="doc-class_method">
+ (<tt>Object</tt>) <strong>doc</strong>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
4
5
6</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 4</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span>
<span class='ivar'>@doc</span> <span class='op'>||=</span> <span class='const'>ForemanApi</span><span class='period'>.</span><span class='id identifier rubyid_doc'>doc</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>resources</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>hosts</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="boot-instance_method">
- (<tt>Array</tt>) <strong>boot</strong>(params = {}, headers = {})
</h3><div class="docstring">
<div class="discussion">
<p>Returns First item: parsed data; second item: raw body</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>params</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>a hash of params to be passed to the service</p>
</div>
</li>
<li>
<span class='name'>headers</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>additional http headers</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
<ul class="option">
<li>
<span class="name">id</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
</li>
<li>
<span class="name">device</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>boot device, valid devices are disk, cdrom, pxe, bios</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'>
<p>First item: parsed data; second item: raw body</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
147
148
149</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 147</span>
<span class='kw'>def</span> <span class='id identifier rubyid_boot'>boot</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="create-instance_method">
- (<tt>Array</tt>) <strong>create</strong>(params = {}, headers = {})
</h3><div class="docstring">
<div class="discussion">
<p>Returns First item: parsed data; second item: raw body</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>params</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>a hash of params to be passed to the service</p>
</div>
</li>
<li>
<span class='name'>headers</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>additional http headers</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
<ul class="option">
<li>
<span class="name">host</span>
<span class="type">(<tt>Hash</tt>, <tt>nil</tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>allowed keys are:</p>
<ul><li>
<p>architecture_id [String, nil]</p>
</li><li>
<p>compute_resource_id [String, nil]</p>
</li><li>
<p>domain_id [String, nil]</p>
</li><li>
<p>environment_id [String, nil]</p>
</li><li>
<p>hostgroup_id [String, nil]</p>
</li><li>
<p>image_id [String, nil]</p>
</li><li>
<p>medium_id [String, nil]</p>
</li><li>
<p>model_id [String, nil]</p>
</li><li>
<p>operatingsystem_id [String, nil]</p>
</li><li>
<p>owner_id [String, nil]</p>
</li><li>
<p>progress_report_id [String, nil] uuid to track orchestration tasks status,
get /api/orchestration/:uuid/tasks</p>
</li><li>
<p>ptable_id [String, nil]</p>
</li><li>
<p>puppet_ca_proxy_id [String, nil]</p>
</li><li>
<p>puppet_class_ids [Array, nil]</p>
</li><li>
<p>puppet_proxy_id [String, nil]</p>
</li><li>
<p>sp_subnet_id [String, nil]</p>
</li><li>
<p>subnet_id [String, nil]</p>
</li><li>
<p>build [String, nil]</p>
</li><li>
<p>capabilities [String, nil]</p>
</li><li>
<p>compute_attributes [Hash, nil]</p>
</li><li>
<p>enabled [String, nil]</p>
</li><li>
<p>host_parameters_attributes [Array, nil]</p>
</li><li>
<p>ip [String, nil] not required if using a subnet with dhcp proxy</p>
</li><li>
<p>mac [String, nil] not required if its a virtual machine</p>
</li><li>
<p>managed [String, nil]</p>
</li><li>
<p>name [String]</p>
</li><li>
<p>provision_method [String, nil]</p>
</li></ul>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'>
<p>First item: parsed data; second item: raw body</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
62
63
64</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 62</span>
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="destroy-instance_method">
- (<tt>Array</tt>) <strong>destroy</strong>(params = {}, headers = {})
</h3><div class="docstring">
<div class="discussion">
<p>Returns First item: parsed data; second item: raw body</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>params</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>a hash of params to be passed to the service</p>
</div>
</li>
<li>
<span class='name'>headers</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>additional http headers</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
<ul class="option">
<li>
<span class="name">id</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'>
<p>First item: parsed data; second item: raw body</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
109
110
111</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 109</span>
<span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="facts-instance_method">
- (<tt>Array</tt>) <strong>facts</strong>(params = {}, headers = {})
</h3><div class="docstring">
<div class="discussion">
<p>Returns First item: parsed data; second item: raw body</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>params</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>a hash of params to be passed to the service</p>
</div>
</li>
<li>
<span class='name'>headers</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>additional http headers</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
<ul class="option">
<li>
<span class="name">certname</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>optional: certname of the host</p>
</div>
</li>
<li>
<span class="name">facts</span>
<span class="type">(<tt>Hash</tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>hash containing the facts for the host</p>
</div>
</li>
<li>
<span class="name">name</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>hostname of the host</p>
</div>
</li>
<li>
<span class="name">type</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>optional: the sti type of host to create</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'>
<p>First item: parsed data; second item: raw body</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
159
160
161</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 159</span>
<span class='kw'>def</span> <span class='id identifier rubyid_facts'>facts</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="index-instance_method">
- (<tt>Array</tt>) <strong>index</strong>(params = {}, headers = {})
</h3><div class="docstring">
<div class="discussion">
<p>Returns First item: parsed data; second item: raw body</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>params</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>a hash of params to be passed to the service</p>
</div>
</li>
<li>
<span class='name'>headers</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>additional http headers</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
<ul class="option">
<li>
<span class="name">order</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>sort results</p>
</div>
</li>
<li>
<span class="name">page</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>paginate results</p>
</div>
</li>
<li>
<span class="name">per_page</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>number of entries per request</p>
</div>
</li>
<li>
<span class="name">search</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>filter results</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'>
<p>First item: parsed data; second item: raw body</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
16
17
18</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 16</span>
<span class='kw'>def</span> <span class='id identifier rubyid_index'>index</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="power-instance_method">
- (<tt>Array</tt>) <strong>power</strong>(params = {}, headers = {})
</h3><div class="docstring">
<div class="discussion">
<p>Returns First item: parsed data; second item: raw body</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>params</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>a hash of params to be passed to the service</p>
</div>
</li>
<li>
<span class='name'>headers</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>additional http headers</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
<ul class="option">
<li>
<span class="name">id</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
</li>
<li>
<span class="name">power_action</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>power action, valid actions are (‘on’, ‘start’)’, (‘off’, ‘stop’), (‘soft’,
‘reboot’), (‘cycle’, ‘reset’), (‘state’, ‘status’)</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'>
<p>First item: parsed data; second item: raw body</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
137
138
139</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 137</span>
<span class='kw'>def</span> <span class='id identifier rubyid_power'>power</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="puppetrun-instance_method">
- (<tt>Array</tt>) <strong>puppetrun</strong>(params = {}, headers = {})
</h3><div class="docstring">
<div class="discussion">
<p>Returns First item: parsed data; second item: raw body</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>params</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>a hash of params to be passed to the service</p>
</div>
</li>
<li>
<span class='name'>headers</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>additional http headers</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
<ul class="option">
<li>
<span class="name">id</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'>
<p>First item: parsed data; second item: raw body</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
127
128
129</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 127</span>
<span class='kw'>def</span> <span class='id identifier rubyid_puppetrun'>puppetrun</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="show-instance_method">
- (<tt>Array</tt>) <strong>show</strong>(params = {}, headers = {})
</h3><div class="docstring">
<div class="discussion">
<p>Returns First item: parsed data; second item: raw body</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>params</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>a hash of params to be passed to the service</p>
</div>
</li>
<li>
<span class='name'>headers</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>additional http headers</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
<ul class="option">
<li>
<span class="name">id</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'>
<p>First item: parsed data; second item: raw body</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
25
26
27</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 25</span>
<span class='kw'>def</span> <span class='id identifier rubyid_show'>show</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="status-instance_method">
- (<tt>Array</tt>) <strong>status</strong>(params = {}, headers = {})
</h3><div class="docstring">
<div class="discussion">
<p>Returns First item: parsed data; second item: raw body</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>params</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>a hash of params to be passed to the service</p>
</div>
</li>
<li>
<span class='name'>headers</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>additional http headers</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
<ul class="option">
<li>
<span class="name">id</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'>
<p>First item: parsed data; second item: raw body</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
118
119
120</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 118</span>
<span class='kw'>def</span> <span class='id identifier rubyid_status'>status</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="update-instance_method">
- (<tt>Array</tt>) <strong>update</strong>(params = {}, headers = {})
</h3><div class="docstring">
<div class="discussion">
<p>Returns First item: parsed data; second item: raw body</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>params</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>a hash of params to be passed to the service</p>
</div>
</li>
<li>
<span class='name'>headers</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'>
<p>additional http headers</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>params</tt>):</p>
<ul class="option">
<li>
<span class="name">id</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
</li>
<li>
<span class="name">host</span>
<span class="type">(<tt>Hash</tt>, <tt>nil</tt>)</span>
<span class="default">
</span>
— <div class='inline'>
<p>allowed keys are:</p>
<ul><li>
<p>architecture_id [String, nil]</p>
</li><li>
<p>compute_resource_id [String, nil]</p>
</li><li>
<p>domain_id [String, nil]</p>
</li><li>
<p>environment_id [String, nil]</p>
</li><li>
<p>hostgroup_id [String, nil]</p>
</li><li>
<p>image_id [String, nil]</p>
</li><li>
<p>medium_id [String, nil]</p>
</li><li>
<p>model_id [String, nil]</p>
</li><li>
<p>operatingsystem_id [String, nil]</p>
</li><li>
<p>owner_id [String, nil]</p>
</li><li>
<p>progress_report_id [String, nil] uuid to track orchestration tasks status,
get /api/orchestration/:uuid/tasks</p>
</li><li>
<p>ptable_id [String, nil]</p>
</li><li>
<p>puppet_ca_proxy_id [String, nil]</p>
</li><li>
<p>puppet_class_ids [Array, nil]</p>
</li><li>
<p>puppet_proxy_id [String, nil]</p>
</li><li>
<p>sp_subnet_id [String, nil]</p>
</li><li>
<p>subnet_id [String, nil]</p>
</li><li>
<p>build [String, nil]</p>
</li><li>
<p>capabilities [String, nil]</p>
</li><li>
<p>compute_attributes [Hash, nil]</p>
</li><li>
<p>enabled [String, nil]</p>
</li><li>
<p>host_parameters_attributes [Array, nil]</p>
</li><li>
<p>ip [String, nil] not required if using a subnet with dhcp proxy</p>
</li><li>
<p>mac [String, nil] not required if its a virtual machine</p>
</li><li>
<p>managed [String, nil]</p>
</li><li>
<p>name [String]</p>
</li><li>
<p>provision_method [String, nil]</p>
</li></ul>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Array</tt>)</span>
—
<div class='inline'>
<p>First item: parsed data; second item: raw body</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
100
101
102</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/foreman_api/resources/host.rb', line 100</span>
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_perform_call'>perform_call</span><span class='lparen'>(</span><span class='id identifier rubyid___method__'>__method__</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_headers'>headers</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Thu Jan 23 15:40:32 2014 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.8.7 (ruby-2.0.0).
</div>
</body>
</html>