253 lines
10 KiB
HTML
253 lines
10 KiB
HTML
|
|
||
|
|
<!doctype html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||
|
|
<html>
|
||
|
|
<head><META http-equiv="Content-Type" content="text/html; charset=utf-8">
|
||
|
|
<title>Add Community for SNMP (ADDCOMSNMP)</title>
|
||
|
|
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
|
||
|
|
</head>
|
||
|
|
<body bgcolor="white">
|
||
|
|
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<a name="ADDCOMSNMP.Top_Of_Page"></a>
|
||
|
|
<h2>Add Community for SNMP (ADDCOMSNMP)</h2>
|
||
|
|
<table width="100%">
|
||
|
|
<tr>
|
||
|
|
<td valign="top" align="left"><b>Where allowed to run: </b>All environments (*ALL)<br>
|
||
|
|
<b>Threadsafe: </b>No
|
||
|
|
</td>
|
||
|
|
<td valign="top" align="right">
|
||
|
|
<a href="#ADDCOMSNMP.PARAMETERS.TABLE">Parameters</a><br>
|
||
|
|
<a href="#ADDCOMSNMP.COMMAND.EXAMPLES">Examples</a><br>
|
||
|
|
<a href="#ADDCOMSNMP.ERROR.MESSAGES">Error messages</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<div> <a name="ADDCOMSNMP"></a>
|
||
|
|
<p>The Add Community for SNMP (ADDCOMSNMP) command defines an SNMP community profile and adds it to the SNMP agent community list. An SNMP agent uses a community profile to determine whether or not to honor a request sent by an SNMP manager. The community profile consists of a community name, an object access specification, and a list of the SNMP managers that are part of the community. The community name combined with the ASCII community (ASCIICOM) parameter defines a community.
|
||
|
|
</p>
|
||
|
|
<p>Multiple community profiles, each having a unique community name may exist in the SNMP agent community list at one time. Similarly, the same internet address may appear in more than one community profile.
|
||
|
|
</p>
|
||
|
|
<p>The OS/400 SNMP agent does not support community views. A view is a subset of the objects in the management information base (MIB). Each OS/400 community consists of all of the objects in the MIB.
|
||
|
|
</p>
|
||
|
|
<p><b>Restrictions:</b> An SNMP manager sends three types of requests: get, get-next, and set. Get and get-next requests are used to read management information base (MIB) variables, and a set request is used to modify MIB variables. For a request from an SNMP manager to be accepted by the AS/400 SNMP agent, all of the following must be true:
|
||
|
|
</p>
|
||
|
|
<ol>
|
||
|
|
<li>The community name in the SNMP manager request specifies a defined community.
|
||
|
|
</li>
|
||
|
|
<li>The internet address of the manager that sent the request must be listed in the community profile.
|
||
|
|
</li>
|
||
|
|
<li>For a set request, the community object access must allow write operations to occur. For a get request or get-next request, read operations must be allowed.
|
||
|
|
</li>
|
||
|
|
<li>For a set request, the object specified in the request must be able to be changed. For a get request or get-next request, the object must be readable.
|
||
|
|
</li>
|
||
|
|
</ol>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#ADDCOMSNMP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<hr size="2" width="100%">
|
||
|
|
|
||
|
|
<div>
|
||
|
|
<h3><a name="ADDCOMSNMP.PARAMETERS.TABLE">Parameters</a></h3>
|
||
|
|
<table border="1" cellpadding="4" cellspacing="0">
|
||
|
|
<!-- col1="10" col2="15" col3="30" col4="10" -->
|
||
|
|
<tr>
|
||
|
|
<th bgcolor="aqua" valign="bottom" align="left">Keyword</th>
|
||
|
|
<th bgcolor="aqua" valign="bottom" align="left">Description</th>
|
||
|
|
<th bgcolor="aqua" valign="bottom" align="left">Choices</th>
|
||
|
|
<th bgcolor="aqua" valign="bottom" align="left">Notes</th>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#ADDCOMSNMP.COM"><b>COM</b></a></td>
|
||
|
|
<td valign="top">Community name</td>
|
||
|
|
<td valign="top"><i>Character value</i></td>
|
||
|
|
<td valign="top">Required, Positional 1</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#ADDCOMSNMP.ASCIICOM"><b>ASCIICOM</b></a></td>
|
||
|
|
<td valign="top">Translate community name</td>
|
||
|
|
<td valign="top"><b><u>*YES</u></b>, *NO</td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#ADDCOMSNMP.INTNETADR"><b>INTNETADR</b></a></td>
|
||
|
|
<td valign="top">Manager internet address</td>
|
||
|
|
<td valign="top">Single values: <b><u>*ANY</u></b><br>Other values (up to 300 repetitions): <i>Character value</i></td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#ADDCOMSNMP.OBJACC"><b>OBJACC</b></a></td>
|
||
|
|
<td valign="top">Object access</td>
|
||
|
|
<td valign="top"><b><u>*SNMPATR</u></b>, *READ, *WRITE, *NONE</td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#ADDCOMSNMP.LOGSET"><b>LOGSET</b></a></td>
|
||
|
|
<td valign="top">Log set requests</td>
|
||
|
|
<td valign="top"><b><u>*SNMPATR</u></b>, *YES, *NO</td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td valign="top"><a href="#ADDCOMSNMP.LOGGET"><b>LOGGET</b></a></td>
|
||
|
|
<td valign="top">Log get requests</td>
|
||
|
|
<td valign="top"><b><u>*SNMPATR</u></b>, *YES, *NO</td>
|
||
|
|
<td valign="top">Optional</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#ADDCOMSNMP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<div> <a name="ADDCOMSNMP.COM"></a>
|
||
|
|
<h3>Community name (COM)</h3>
|
||
|
|
<p>Specifies the name of the SNMP community being added. Each SNMP community name must be unique.
|
||
|
|
</p>
|
||
|
|
<p>The possible values are:
|
||
|
|
</p>
|
||
|
|
<dl>
|
||
|
|
<dt><b><i>community-name</i></b></dt>
|
||
|
|
<dd>Specify the name of the SNMP community being added. The name may contain characters that cannot be displayed.
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#ADDCOMSNMP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="ADDCOMSNMP.ASCIICOM"></a>
|
||
|
|
<h3>Translate community name (ASCIICOM)</h3>
|
||
|
|
<p>Specifies whether the community name is translated to ASCII characters when the community profile is added to the SNMP agent community list.
|
||
|
|
</p>
|
||
|
|
<p>The possible values are:
|
||
|
|
</p>
|
||
|
|
<dl>
|
||
|
|
<dt><b><u>*YES</u></b></dt>
|
||
|
|
<dd>The community name is translated to ASCII characters when the community profile is added to the SNMP agent community list. This value should be specified if the SNMP manager system defines its community names entirely of ASCII characters. An error message is sent if the community name cannot be translated to ASCII characters.
|
||
|
|
</dd>
|
||
|
|
<dt><b>*NO</b></dt>
|
||
|
|
<dd>The community name is not translated to ASCII characters when the community profile is added to the SNMP agent community list. This value should be specified if the SNMP manager system defines its community names using EBCDIC characters or characters that cannot be displayed.
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#ADDCOMSNMP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="ADDCOMSNMP.INTNETADR"></a>
|
||
|
|
<h3>Manager internet address (INTNETADR)</h3>
|
||
|
|
<p>Specifies the internet addresses of the SNMP managers that are part of this community.
|
||
|
|
</p>
|
||
|
|
<p>The possible values are:
|
||
|
|
</p>
|
||
|
|
<dl>
|
||
|
|
<dt><b><u>*ANY</u></b></dt>
|
||
|
|
<dd>Allow any SNMP manager to be part of this community.
|
||
|
|
</dd>
|
||
|
|
<dt><b><i>manager-internet-address</i></b></dt>
|
||
|
|
<dd>Specify the internet address of the SNMP manager. The internet address is specified in the form <i>nnn.nnn.nnn.nnn</i>, where <i>nnn</i> is a decimal number ranging from 0 through 255. An internet address is not valid if it has a value of all binary ones or all binary zeros for the network identifier (ID) portion or the host ID portion of the address. If the internet address is entered from a command line, the address must be enclosed in apostrophes. Up to 300 unique internet addresses may be specified. The same internet address may appear in more than one community profile.
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#ADDCOMSNMP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="ADDCOMSNMP.OBJACC"></a>
|
||
|
|
<h3>Object access (OBJACC)</h3>
|
||
|
|
<p>Specifies the object access for the community.
|
||
|
|
</p>
|
||
|
|
<p>The possible values are:
|
||
|
|
</p>
|
||
|
|
<dl>
|
||
|
|
<dt><b><u>*SNMPATR</u></b></dt>
|
||
|
|
<dd>The object access defined with the Change SNMP Attributes (CHGSNMPA) command is used for this community.
|
||
|
|
</dd>
|
||
|
|
<dt><b>*READ</b></dt>
|
||
|
|
<dd>Allow SNMP managers that are part of this community to read all management information base (MIB) objects with get or get-next requests. Modification of MIB objects by SNMP managers is not permitted.
|
||
|
|
</dd>
|
||
|
|
<dt><b>*WRITE</b></dt>
|
||
|
|
<dd>Allow SNMP managers that are part of this community to change all MIB objects that are able to change with set requests. Specifying *WRITE implies *READ access.
|
||
|
|
</dd>
|
||
|
|
<dt><b>*NONE</b></dt>
|
||
|
|
<dd>Do not allow SNMP managers that are part of this community any access to MIB objects.
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#ADDCOMSNMP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="ADDCOMSNMP.LOGSET"></a>
|
||
|
|
<h3>Log set requests (LOGSET)</h3>
|
||
|
|
<p>Specifies whether set requests from SNMP managers in this community are logged in journal QSNMP in library QUSRSYS.
|
||
|
|
</p>
|
||
|
|
<p>The possible values are:
|
||
|
|
</p>
|
||
|
|
<dl>
|
||
|
|
<dt><b><u>*SNMPATR</u></b></dt>
|
||
|
|
<dd>The value defined with the Change SNMP Attributes (CHGSNMPA) command is used for this community.
|
||
|
|
</dd>
|
||
|
|
<dt><b>*YES</b></dt>
|
||
|
|
<dd>Set requests are logged.
|
||
|
|
</dd>
|
||
|
|
<dt><b>*NO</b></dt>
|
||
|
|
<dd>Set requests are not logged.
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#ADDCOMSNMP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<div> <a name="ADDCOMSNMP.LOGGET"></a>
|
||
|
|
<h3>Log get requests (LOGGET)</h3>
|
||
|
|
<p>Specifies whether get requests and get-next requests from SNMP managers in this community are logged in journal QSNMP in library QUSRSYS.
|
||
|
|
</p>
|
||
|
|
<p>The possible values are:
|
||
|
|
</p>
|
||
|
|
<dl>
|
||
|
|
<dt><b><u>*SNMPATR</u></b></dt>
|
||
|
|
<dd>The value defined with the Change SNMP Attributes (CHGSNMPA) command is used for this community.
|
||
|
|
</dd>
|
||
|
|
<dt><b>*YES</b></dt>
|
||
|
|
<dd>Get requests and get-next requests are logged.
|
||
|
|
</dd>
|
||
|
|
<dt><b>*NO</b></dt>
|
||
|
|
<dd>Get requests and get-next requests are not logged.
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#ADDCOMSNMP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<hr size="2" width="100%">
|
||
|
|
<div><h3><a name="ADDCOMSNMP.COMMAND.EXAMPLES">Examples</a> </h3>
|
||
|
|
<p>
|
||
|
|
<pre>
|
||
|
|
ADDCOMSNMP COM(ROCHESTER) INTNETADR('8.6.5.4' '8.6.5.3')
|
||
|
|
OBJACC(*WRITE)
|
||
|
|
</pre>
|
||
|
|
</p>
|
||
|
|
<p>This command adds the community ROCHESTER to the SNMP agent community list. SNMP managers with internet addresses 8.6.5.4 and 8.6.5.3 are the only managers in the community and are able to change all MIB objects.
|
||
|
|
</p>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#ADDCOMSNMP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
<hr size="2" width="100%">
|
||
|
|
<div><h3><a name="ADDCOMSNMP.ERROR.MESSAGES">Error messages</a> </h3>
|
||
|
|
<p><b><u>*ESCAPE Messages</u></b>
|
||
|
|
</p>
|
||
|
|
<dl>
|
||
|
|
<dt><b>TCP4001</b></dt>
|
||
|
|
<dd>Error occurred accessing SNMP configuration information.
|
||
|
|
</dd>
|
||
|
|
<dt><b>TCP4008</b></dt>
|
||
|
|
<dd>Community already exists. Reason code &3.
|
||
|
|
</dd>
|
||
|
|
<dt><b>TCP8050</b></dt>
|
||
|
|
<dd>*IOSYSCFG authority required to use &1.
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</div>
|
||
|
|
<table width="100%">
|
||
|
|
<tr><td align="right"><a href="#ADDCOMSNMP.Top_Of_Page">Top</a></td></tr>
|
||
|
|
</table>
|
||
|
|
</body>
|
||
|
|
</html>
|