ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/xtodreq.htm

178 lines
5.8 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">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>DHCP Request Packet Validation Exit Program</title>
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Begin Header Records ========================================== -->
<!-- XTODREQ SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA at -->
<!-- RCHVMW2 on 21 Oct 1998 at 18:15:52 -->
<!--File Edited Oct 2001 -->
<!--End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<a name="Top_Of_Page"></a>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<h2>DHCP Request Packet Validation Exit Program</h2>
<div class="box" style="width: 70%;">
<br>
&nbsp;&nbsp;Required Parameter Group:<br>
<!-- iddvc RMBR -->
<br>
<table width="100%">
<tr>
<td align="center" valign="top" width="10%">1</td>
<td align="left" valign="top" width="50%">Request packet</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Length of request packet</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Allow operation</td>
<td align="left" valign="top">Output</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Exit Point Name: QIBM_QTOD_DHCP_REQ<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Exit Point Format Name: DHCV0100<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The Dynamic Host Configuration Protocol (DHCP) Request Packet
Validation exit program provides additional control for restricting which
incoming DHCP and Bootstrap Protocol (BOOTP) message request packets from
client hosts are processed by the DHCP server, and which should be
rejected. Any restrictions that are imposed by the exit program are in
addition to any validation that is performed by the DHCP server program
through its configuration options. When an exit program is added to the
exit point, it is called by the DHCP server each time an incoming DHCP or
BOOTP request packet is received, but before any processing of the packet
has taken place. The packet data is passed to the exit program just as it
was received off the network without any additional formatting or data
conversion. The exit program sets the allow operation parameter to
indicate whether the DHCP server should continue with normal processing of
the request packet. If the exit program indicates that the request packet
should be rejected, the DHCP server will discard the packet without any
further processing.</p>
<p><strong>Note:</strong> Since this is an exit point of the DHCP server,
the exit program can only be used to restrict BOOTP packets if the DHCP
server is running. It cannot be used to restrict BOOTP packets from being
processed by the BOOTP server.</p>
<br>
<!-- Please NOTE: DO NOT DELETE THIS SECTION if this API has no authorities and locks. -->
<!-- Instead, use the commented out coding below to indicate NONE. -->
<h3>Authorities and Locks</h3>
<!-- Use this if there are no authorities and locks. -->
<p>None.</p>
<br>
<h3>Required Parameter Group</h3>
<dl>
<dt><strong>Request packet</strong></dt>
<dd>INPUT; CHAR(*)
<p>The DHCP or BOOTP message request packet that was initiated from some
client host and received by the DHCP server. It is in its initial form,
which is how it comes off of the network.</p>
<p>The formats of the packets are defined and maintained by the Internet
Engineering Task Force (IETF) standards body. Refer to the following IETF
Request For Comments (RFC) documents for the specifications:</p>
<ul>
<li>RFC 951, Bootstrap Protocol (BOOTP)</li>
<li>RFC 1542, Clarifications and Extensions for the Bootstrap
Protocol</li>
<li>RFC 2131, Dynamic Host Configuration Protocol</li>
<li>RFC 2132, DHCP Options and BOOTP Vendor Extensions</li>
</ul>
<p><strong>Note:</strong> Since the packet is presented to the exit
program just as it was received from the network, it should be noted that
any data areas of the packet that are defined as type string or character
by the RFCs will be US-ASCII. On the iSeries, it is recommended that this
data be treated as CCSID 819.</p>
</dd>
<dt><strong>Length of request packet</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length (in bytes) of the request packet.</p>
</dd>
<dt><strong>Allow operation</strong></dt>
<dd>OUTPUT; BINARY(4)
<p>Whether the DHCP server should continue processing the request packet,
or whether it should be rejected. The possible values are:</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>0</em></td>
<td align="left" valign="top">The request packet should be rejected</td>
</tr>
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">Processing of the request packet should be allowed to
continue</td>
</tr>
</table>
</dl>
<br>
<hr>
Exit program introduced: V4R2
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center">
<a href="#Top_Of_Page">Top</a> |
<a href="ss1.htm">Server Support APIs</a> |
<a href="aplist.htm">APIs by category</a></td>
</tr>
</table>
</center>
</body>
</html>