<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Configures security-related SNMPv3 session parameters</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="snmp.set.html">SNMP::set</a></div>
<div class="next" style="text-align: right; float: right;"><a href="snmp.walk.html">SNMP::walk</a></div>
<div class="up"><a href="class.snmp.html">SNMP</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="snmp.setsecurity" class="refentry">
<div class="refnamediv">
<h1 class="refname">SNMP::setSecurity</h1>
<p class="verinfo">(PHP 5 >= 5.4.0)</p><p class="refpurpose"><span class="refname">SNMP::setSecurity</span> — <span class="dc-title">Configures security-related <acronym title="Simple Network Management Protocol">SNMP</acronym>v3 session parameters</span></p>
</div>
<div class="refsect1 description" id="refsect1-snmp.setsecurity-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>SNMP::setSecurity</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$sec_level</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$auth_protocol</code><span class="initializer"> = </span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$auth_passphrase</code><span class="initializer"> = </span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$priv_protocol</code><span class="initializer"> = </span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$priv_passphrase</code><span class="initializer"> = </span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$contextName</code><span class="initializer"> = </span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$contextEngineID</code><span class="initializer"> = </span>
]]]]]] )</div>
<p class="para rdfs-comment">
setSecurity configures security-related session parameters used in <acronym title="Simple Network Management Protocol">SNMP</acronym> protocol version 3
</p>
</div>
<div class="refsect1 parameters" id="refsect1-snmp.setsecurity-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">sec_level</code></em></span>
<dd>
<p class="para">
the security level (noAuthNoPriv|authNoPriv|authPriv)
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">auth_protocol</code></em></span>
<dd>
<p class="para">
the authentication protocol (MD5 or SHA)
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">auth_passphrase</code></em></span>
<dd>
<p class="para">
the authentication pass phrase
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">priv_protocol</code></em></span>
<dd>
<p class="para">
the privacy protocol (DES or AES)
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">priv_passphrase</code></em></span>
<dd>
<p class="para">
the privacy pass phrase
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">contextName</code></em></span>
<dd>
<p class="para">
the context name
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">contextEngineID</code></em></span>
<dd>
<p class="para">
the context EngineID
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-snmp.setsecurity-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-snmp.setsecurity-examples">
<h3 class="title">Examples</h3>
<div class="example" id="snmp.setsecurity.example.basic">
<p><strong>Example #1 <span class="methodname"><strong>SNMP::setSecurity()</strong></span> example</strong></p>
<div class="example-contents"><p>
</p></div>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /> $session </span><span style="color: #007700">= new </span><span style="color: #0000BB">SNMP</span><span style="color: #007700">(</span><span style="color: #0000BB">SNMP</span><span style="color: #007700">::</span><span style="color: #0000BB">VERSION_3</span><span style="color: #007700">, </span><span style="color: #0000BB">$hostname</span><span style="color: #007700">, </span><span style="color: #0000BB">$rwuser</span><span style="color: #007700">, </span><span style="color: #0000BB">$timeout</span><span style="color: #007700">, </span><span style="color: #0000BB">$retries</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$session</span><span style="color: #007700">-></span><span style="color: #0000BB">setSecurity</span><span style="color: #007700">(</span><span style="color: #DD0000">'authPriv'</span><span style="color: #007700">, </span><span style="color: #DD0000">'MD5'</span><span style="color: #007700">, </span><span style="color: #0000BB">$auth_pass</span><span style="color: #007700">, </span><span style="color: #DD0000">'AES'</span><span style="color: #007700">, </span><span style="color: #0000BB">$priv_pass</span><span style="color: #007700">, </span><span style="color: #DD0000">''</span><span style="color: #007700">, </span><span style="color: #DD0000">'aeeeff'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</div>
<div class="refsect1 seealso" id="refsect1-snmp.setsecurity-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"> <span class="methodname"><a href="snmp.construct.html" class="methodname" rel="rdfs-seeAlso">SNMP::__construct()</a> - Creates SNMP instance representing session to remote SNMP agent</span></li>
</ul>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="snmp.set.html">SNMP::set</a></div>
<div class="next" style="text-align: right; float: right;"><a href="snmp.walk.html">SNMP::walk</a></div>
<div class="up"><a href="class.snmp.html">SNMP</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
