ibm-information-center/dist/eclipse/plugins/i5OS.ic.cl_5.4.0.1/addipsloc.htm

237 lines
13 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<!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 IP over SNA Location (ADDIPSLOC)</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="ADDIPSLOC.Top_Of_Page"></a>
<h2>Add IP over SNA Location (ADDIPSLOC)</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="#ADDIPSLOC.PARAMETERS.TABLE">Parameters</a><br>
<a href="#ADDIPSLOC.COMMAND.EXAMPLES">Examples</a><br>
<a href="#ADDIPSLOC.ERROR.MESSAGES">Error messages</a></td>
</tr>
</table>
<div> <a name="ADDIPSLOC"></a>
<p>The Add IP over SNA Location Entry (ADDIPSLOC) command is used to define AF_INET sockets over SNA location mapping entries. AF_INET sockets over SNA requires that an SNA location (network identifier/location name) be defined for each IP address that can be reached on an SNA transport. The location mapping entries define the SNA location for each IP address.
</p>
<p>The SNA locations can be identified in one of two ways:
</p>
<ul>
<li>A single host (or IP address) is specified with a single SNA location (network identifier/location name).
</li>
<li>A group of hosts designated by the network ID portion of the IP address is specified with a given SNA network identifier and a location name template.
</li>
</ul>
<p><b>Restriction:</b> The user must have *IOSYSCFG authority to use this command.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDIPSLOC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div>
<h3><a name="ADDIPSLOC.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="#ADDIPSLOC.RMTDEST"><b>RMTDEST</b></a></td>
<td valign="top">Remote destination</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Required, Positional 1</td>
</tr>
<tr>
<td valign="top"><a href="#ADDIPSLOC.SUBNETMASK"><b>SUBNETMASK</b></a></td>
<td valign="top">Subnet mask</td>
<td valign="top"><i>Character value</i>, *HOST</td>
<td valign="top">Required, Positional 2</td>
</tr>
<tr>
<td valign="top"><a href="#ADDIPSLOC.RMTNETID"><b>RMTNETID</b></a></td>
<td valign="top">Remote network identifier</td>
<td valign="top"><i>Communications name</i>, <b><u>*NETATR</u></b></td>
<td valign="top">Optional</td>
</tr>
<tr>
<td valign="top"><a href="#ADDIPSLOC.LOCTPL"><b>LOCTPL</b></a></td>
<td valign="top">Location template</td>
<td valign="top"><i>Character value</i></td>
<td valign="top">Optional</td>
</tr>
</table>
<table width="100%">
<tr><td align="right"><a href="#ADDIPSLOC.Top_Of_Page">Top</a></td></tr>
</table>
</div>
<div> <a name="ADDIPSLOC.RMTDEST"></a>
<h3>Remote destination (RMTDEST)</h3>
<p>Specifies the remote network, subnetwork or host associated with this location entry. You must specify all four bytes that make up an internet address though some of the bytes may be equal to 0. For example, a remote route destination to all the hosts on the 9.5.11 subnetwork is identified by entering 9.5.11.0 for the remote route destination. Used in combination with a subnet mask value, the remote route destination will identify a remote network or system.
</p>
<p>The remote route destination can be specified in the form nnn.0.0.0 for class A, nnn.nnn.0.0 for class B, and nnn.nnn.nnn.0 for class C, or nnn.nnn.nnn.nnn for any combination thereof, where nnn is a decimal number ranging from 0 through 255. Any combination thereof means that you may specify remote route destination such as 9.5.0.0 to the hosts on the 9.5 subnet, even though all 9.5.x.x addresses are class A network addresses.
</p>
<p>This is a required parameter.
</p>
<p><b>Restrictions:</b>
</p>
<ol>
<li>The remote route destination cannot start with a zero (0); for example, 0.nnn.nnn.nnn.
</li>
<li>The remote route destination cannot start with 127; for example, 127.nnn.nnn.nnn. This address range is reserved for TCP/IP loopback addresses.
</li>
<li>The remote route destination cannot be a class D or class E address. Class D addresses range from 224.nnn.nnn.nnn to 239.nnn.nnn.nnn. Class E addresses range from 240.nnn.nnn.nnn to 255.nnn.nnn.nnn.
</li>
<li>You cannot specify a remote route destination of 255.255.255.255. This is the limited broadcast address.
</li>
<li>You cannot specify a directed broadcast address for the remote route destination; for example, nnn.255.255.255 for class A, nnn.nnn.255.255 for class B, and nnn.nnn.nnn.255 for class C.
</li>
<li>For a single host remote route destination, all bits in the host portion of the IP address cannot be zero (0).
</li>
</ol>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDIPSLOC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDIPSLOC.SUBNETMASK"></a>
<h3>Subnet mask (SUBNETMASK)</h3>
<p>Specifies a bit mask that identifies to AF_INET sockets over SNA which bits of the value specified for the remote route destination (RMTDEST) compose the network and subnet portions of the internet address. By defining the network portion and subnetwork portion of the RMTDEST address, the subnet mask also defines which bits of the RMTDEST address make up the host portion. The mask is a 32-bit combination that is logically ANDed with the internet address to determine a particular subnetwork. The bits of the mask set to the value one (1) determine the network and subnetwork portions of the address. The bits set to the value zero (0) determine the host portion of the address.
</p>
<p>This is a required parameter.
</p>
<p>
<b>Note: </b>The network portion must be equal to one bits in the subnetmask. The host portion and the subnetmask portion of an address must both be at least two bits wide.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b>*HOST</b></dt>
<dd>The internet address value specified in the remote route destination field is a host address. The subnet mask value is calculated to be 255.255.255.255.
</dd>
<dt><b><i>subnet-mask</i></b></dt>
<dd>Specify the mask for the network subnet field and host address field of the internet address that defines a subnetwork. The subnetwork mask is in the form, <i>nnn.nnn.nnn.nnn</i>, where <i>nnn</i> is a decimal number ranging from 0 through 255. The subnet mask must mask off all bits of the network class's network ID portion of the internet address. This means the subnet mask for a class A address must be 255.nnn.nnn.nnn, the subnet mask for a class B address must be 255.255.nnn.nnn, and the subnet mask for a class C address must be 255.255.255.nnn.
<p>For example, 255.255.255.0 could define a subnet mask for an interface with a class B internet address. In this example, the first two octets must be 1 bits because these octets define the network ID portion of the class B internet address. The third octet of this subnet mask defines the actual subnet mask ID portion of the interface's internet address. It is also all 1 bits. This leaves the fourth octet to define the host ID portion of the interface's internet address.
</p>
<p>For example, a remote route destination's internet address value of 129.35.192.0 identifies a class B subnetwork. The network ID part of its address is 129.35. The portion of the subnetmask that is associated with the network portion of a particular class of address must equal 255. Therefore, the upper 2 bytes must be equal to 255.255 in the subnetmask. The subnetmask in this example may be 255.255.192.0 if the third octet is used as the subnetwork ID portion of the internet address.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDIPSLOC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDIPSLOC.RMTNETID"></a>
<h3>Remote network identifier (RMTNETID)</h3>
<p>Specifies the name of the remote SNA network associated with this IP network or IP address.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><u>*NETATR</u></b></dt>
<dd>The remote network identifier specified in the network attributes is used.
</dd>
<dt><b><i>remote-sna-network-identifier</i></b></dt>
<dd>Specify the remote network identifier. This identifier can be one to eight characters in length. The first character must be A (or a) through Z (or z), or special characters $, #, or @ followed by 0 through 9, A (or a) through Z (or z), $, #, or @.
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDIPSLOC.Top_Of_Page">Top</a></td></tr>
</table>
<div> <a name="ADDIPSLOC.LOCTPL"></a>
<h3>Location template (LOCTPL)</h3>
<p>Specifies the SNA location names associated with the IP network or subnetwork specified by the remote route destination or a single location name if the remote route destination address is for a single host.
</p>
<p>This is a required parameter.
</p>
<p>The possible values are:
</p>
<dl>
<dt><b><i>location-name-template</i></b></dt>
<dd>Specify an 8 character template to be used by the system for generating remote location names based on the remote IP address specified on socket system calls. The first character must be A (or a) through Z (or z), or special characters $, #, or @ followed by 0 through 9, A (or a) through Z (or z), $, #, @, or ?. The template must specify some of the characters for the location name. The system generates the remaining characters based on the class of the IP address.
<p>System-generated location name characters are identified by a question mark (?) character. Each question mark represents a single character that is generated by the system. A question mark may be used anywhere within the location name template except in the first character position. For example, the following location name templates are valid:
</p>
<ul>
<li>ABCD????
</li>
<li>AB??CD??
</li>
<li>A?B?C?D?
</li>
</ul>
<p><b>Notes:</b>
</p>
<ol>
<li>The number of question mark (?) characters in the template is dependent on how the remote destination (RMTDEST) parameter is used:
<ul>
<li>If the internet address specified for the RMTDEST is for a single host, the SUBNETMASK value must be *HOST or 255.255.255.255 and the LOCTPL value must not contain any question mark (?) characters.
</li>
<li>If the internet address specified for the RMTDEST is for a network or subnetwork, the LOCTPL value must be an 8 character template containing a minimum number of question mark (?) characters based on the number of host mask bits contained in the SUBNETMASK parameter value. The minimum number of question mark characters is determined by dividing the number of host mask bits in the SUBNETMASK value by 5 and rounding up to the next whole number. For example: If the SUBNETMASK is 255.255.255.128, there are 7 host mask bits. In this case there must be 2 question mark characters in the template.
</li>
</ul>
</li>
<li>If the RMTDEST is for a group of hosts, a location name template must be specified. A single location name will not work.
</li>
</ol>
</dd>
<dt><b><i>location-name</i></b></dt>
<dd>Specify the remote location name. This name can be one to eight characters in length. The first character must be A (or a) through Z (or z), or special characters $, #, or @ followed by 0 through 9, A (or a) through Z (or z), $, #, or @.
<p>If the RMTDEST is for a single host, a single location name must be specified. A location template will not work.
</p>
</dd>
</dl>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDIPSLOC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ADDIPSLOC.COMMAND.EXAMPLES">Examples</a> </h3>
<p><b>Example 1: Adding an AF_INET Sockets over SNA Location Entry</b>
</p>
<p>
<pre>
ADDIPSLOC RMTDEST('128.2.0.0') SUBNETMASK('255.255.255.128')
LOCTPL('ABCD????')
</pre>
</p>
<p>This command adds an AF_INET sockets over SNA location entry for a subnetwork with network 128.2 and subnet mask of 255.255.255.128. Remote IP addresses for subnetwork 128.2 specified on socket system calls are algorithmically mapped into SNA names that use the SNA network identifier specified in the network attributes and location names which start with ABCD. The system creates the remaining four characters of the location name based on the IP address. See the Convert IP over SNA Interface (CVTIPSIFC) command for more information.
</p>
<p><b>Example 2: Adding an AF_INET Sockets over SNA Location Entry for a Host</b>
</p>
<p>
<pre>
ADDIPSLOC RMTDEST('128.2.3.4') SUBNETMASK(*HOST) LOCTPL(XYZ00001)
</pre>
</p>
<p>This command adds an AF_INET sockets over SNA location entry for a host at IP address 128.2.3.4. The address 128.2.3.4 is mapped to the SNA location name of XYZ00001 and uses the default SNA network identifier specified in the network attributes.
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDIPSLOC.Top_Of_Page">Top</a></td></tr>
</table>
<hr size="2" width="100%">
<div><h3><a name="ADDIPSLOC.ERROR.MESSAGES">Error messages</a> </h3>
<p>None
</p>
</div>
<table width="100%">
<tr><td align="right"><a href="#ADDIPSLOC.Top_Of_Page">Top</a></td></tr>
</table>
</body>
</html>