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

196 lines
5.6 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 Address Release Notification 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 ========================================= -->
<!-- XTODARLS SCRIPT A converted by B2H R4.1 (346) (CMS) by KENTALA -->
<!-- at RCHVMW2 on 21 Oct 1998 at 18:17:46 -->
<!--File Edited Oct 2001 by Janet Brauckman -->
<!--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 Address Release Notification 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%">Reason for release</td>
<td align="left" valign="top" width="20%">Input</td>
<td align="left" valign="top" width="20%">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">2</td>
<td align="left" valign="top">Client IP address</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">3</td>
<td align="left" valign="top">Length of client IP address</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
<tr>
<td align="center" valign="top">4</td>
<td align="left" valign="top">Client identifier</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Char(*)</td>
</tr>
<tr>
<td align="center" valign="top">5</td>
<td align="left" valign="top">Length of client identifier</td>
<td align="left" valign="top">Input</td>
<td align="left" valign="top">Binary(4)</td>
</tr>
</table>
<br>
&nbsp;&nbsp;Exit Point Name: QIBM_QTOD_DHCP_ARLS<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Exit Point Format Name: DHCR0100<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The DHCP Address Release Notification exit program allows for notification
each time the DHCP server releases an IP address from its specific client host
assignment binding.</p>
<p>An address could have been released from the client that it was bound to for
one of the following reasons:</p>
<ol>
<li>The client explicitly sent a DHCP RELEASE request to the DHCP server.</li>
<li>The lease duration that the client was last given for using the IP address
has expired.</li>
<li>A DHCP server administrator has explicitly released the IP address.</li>
</ol>
<p>When an exit program is added to the exit point, it is called whenever the
DHCP server releases an IP address from the specific client host that it had
been assigned to. This is for notification purposes only, and no data is
expected to be sent back to the DHCP server from the exit program. The exit
program will be sent information about the IP address, the identity of the
client, and the reason for the IP address being released.</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>Reason for release</strong></dt>
<dd>INPUT; BINARY(4)
<p>A reason that the DHCP server has released the IP address from being bound
to the specific client host. The possible values are:</p>
<table cellpadding="3">
<!-- cols="5 95" -->
<tr>
<td align="left" valign="top"><em>1</em></td>
<td align="left" valign="top">The DHCP server received a DHCP RELEASE packet
from the client.</td>
</tr>
<tr>
<td align="left" valign="top"><em>2</em></td>
<td align="left" valign="top">The duration of the lease that the client was
last given for use of the IP address has expired.</td>
</tr>
<tr>
<td align="left" valign="top"><em>3</em></td>
<td align="left" valign="top">The release is forced by DHCP server
administrator.</td>
</tr>
</table>
<br>
</dd>
<dt><strong>Client IP address</strong></dt>
<dd>INPUT; CHAR(*)
<p>The Internet Protocol (IP) address that was just released from its client
host binding. This string is in dotted decimal format and left-justified.</p>
</dd>
<dt><strong>Length of client IP address</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length (in bytes) of the client IP address.</p>
</dd>
<dt><strong>Client identifier</strong></dt>
<dd>INPUT; CHAR(*)
<p>The unique identifier of the client from which the IP address has been
released. This is usually the hardware address of the client machine.</p>
</dd>
<dt><strong>Length of client identifier</strong></dt>
<dd>INPUT; BINARY(4)
<p>The length (in bytes) of the client identifier string.</p>
</dd>
</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>