Files
metasploit-gs/api/Rex/Script/Meterpreter.html
T
jenkins-metasploit c3f5bd3de2 Reboot gh-pages
2026-05-08 17:08:43 +00:00

229 lines
8.3 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Rex::Script::Meterpreter
&mdash; Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Rex::Script::Meterpreter";
relpath = '../../';
</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 class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (M)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Rex.html" title="Rex (module)">Rex</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Script.html" title="Rex::Script (module)">Script</a></span></span>
&raquo;
<span class="title">Meterpreter</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Rex::Script::Meterpreter
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Base.html" title="Rex::Script::Base (class)">Base</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Base.html" title="Rex::Script::Base (class)">Base</a></span></li>
<li class="next">Rex::Script::Meterpreter</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/rex/script/meterpreter.rb</dd>
</dl>
</div>
<h2>Instance Attribute Summary</h2>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Base.html" title="Rex::Script::Base (class)">Base</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Base.html#args-instance_method" title="Rex::Script::Base#args (method)">#args</a></span>, <span class='object_link'><a href="Base.html#client-instance_method" title="Rex::Script::Base#client (method)">#client</a></span>, <span class='object_link'><a href="Base.html#error-instance_method" title="Rex::Script::Base#error (method)">#error</a></span>, <span class='object_link'><a href="Base.html#framework-instance_method" title="Rex::Script::Base#framework (method)">#framework</a></span>, <span class='object_link'><a href="Base.html#path-instance_method" title="Rex::Script::Base#path (method)">#path</a></span>, <span class='object_link'><a href="Base.html#session-instance_method" title="Rex::Script::Base#session (method)">#session</a></span>, <span class='object_link'><a href="Base.html#sink-instance_method" title="Rex::Script::Base#sink (method)">#sink</a></span>, <span class='object_link'><a href="Base.html#workspace-instance_method" title="Rex::Script::Base#workspace (method)">#workspace</a></span></p>
<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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client, path) &#x21d2; Meterpreter </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of Meterpreter.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="Rex::Script::Base (class)">Base</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Base.html#completed-instance_method" title="Rex::Script::Base#completed (method)">#completed</a></span>, <span class='object_link'><a href="Base.html#output-instance_method" title="Rex::Script::Base#output (method)">#output</a></span>, <span class='object_link'><a href="Base.html#print-instance_method" title="Rex::Script::Base#print (method)">#print</a></span>, <span class='object_link'><a href="Base.html#print_error-instance_method" title="Rex::Script::Base#print_error (method)">#print_error</a></span>, <span class='object_link'><a href="Base.html#print_good-instance_method" title="Rex::Script::Base#print_good (method)">#print_good</a></span>, <span class='object_link'><a href="Base.html#print_line-instance_method" title="Rex::Script::Base#print_line (method)">#print_line</a></span>, <span class='object_link'><a href="Base.html#print_status-instance_method" title="Rex::Script::Base#print_status (method)">#print_status</a></span>, <span class='object_link'><a href="Base.html#run-instance_method" title="Rex::Script::Base#run (method)">#run</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(client, path) &#x21d2; <tt><span class='object_link'><a href="" title="Rex::Script::Meterpreter (class)">Meterpreter</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Meterpreter.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
18
19
20
21
22
23
24</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/rex/script/meterpreter.rb', line 18</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
<span class='comment'># The mixins for `Msf::Post::*` now assume a single info argument is present,
</span> <span class='comment'># whilst `::Rex::Script::Base` assumes client and path are provided. Directly call
</span> <span class='comment'># the `::Rex::Script::Base` initialize method for now. In the future Rex scripts
</span> <span class='comment'># will need to be migrated to use post modules
</span> <span class='op'>::</span><span class='const'><span class='object_link'><a href="../../Rex.html" title="Rex (module)">Rex</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Script.html" title="Rex::Script (module)">Script</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Base.html" title="Rex::Script::Base (class)">Base</a></span></span><span class='period'>.</span><span class='id identifier rubyid_instance_method'>instance_method</span><span class='lparen'>(</span><span class='symbol'>:initialize</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_bind'>bind</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_client'>client</span><span class='comma'>,</span> <span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Fri May 8 17:04:14 2026 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.1.5).
</div>
</div>
</body>
</html>