diff options
Diffstat (limited to 'static/freebsd/man4/ng_lmi.4 3.html')
| -rw-r--r-- | static/freebsd/man4/ng_lmi.4 3.html | 120 |
1 files changed, 120 insertions, 0 deletions
diff --git a/static/freebsd/man4/ng_lmi.4 3.html b/static/freebsd/man4/ng_lmi.4 3.html new file mode 100644 index 00000000..16ccdd64 --- /dev/null +++ b/static/freebsd/man4/ng_lmi.4 3.html @@ -0,0 +1,120 @@ +<table class="head"> + <tr> + <td class="head-ltitle">NG_LMI(4)</td> + <td class="head-vol">Device Drivers Manual</td> + <td class="head-rtitle">NG_LMI(4)</td> + </tr> +</table> +<div class="manual-text"> +<section class="Sh"> +<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> +<p class="Pp"><code class="Nm">ng_lmi</code> — <span class="Nd">frame + relay LMI protocol netgraph node type</span></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> +<p class="Pp"><code class="In">#include + <<a class="In">sys/types.h</a>></code> + <br/> + <code class="In">#include + <<a class="In">netgraph/ng_lmi.h</a>></code></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> +<p class="Pp">The <code class="Nm">lmi</code> node type performs the frame relay + LMI protocol. It supports the ITU Annex A, ANSI Annex D, and Group-of-four + LMI types. It also supports auto-detection of the LMI type.</p> +<p class="Pp">To enable a specific LMI type, connect the corresponding hook + (<code class="Dv">annexA</code>, <code class="Dv">annexD</code>, or + <code class="Dv">group4</code>) to DLCI 0 or 1023 of a + <a class="Xr">ng_frame_relay(4)</a> node. Typically, Annex A and Annex D + live on DLCI 0 while Group-of-four lives on DLCI 1023.</p> +<p class="Pp">To enable LMI type auto-detection, connect the + <code class="Dv">auto0</code> hook to DLCI 0 and the + <code class="Dv">auto1023</code> hook to DLCI 1023. The node will attempt to + automatically determine which LMI type is running at the switch, and go into + that mode.</p> +<p class="Pp">Only one fixed LMI type, or auto-detection, can be active at any + given time.</p> +<p class="Pp">The <code class="Dv">NGM_LMI_GET_STATUS</code> control message can + be used at any time to query the current status of the LMI protocol and each + DLCI channel. This node also supports the + <code class="Dv">NGM_TEXT_STATUS</code> control message.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HOOKS"><a class="permalink" href="#HOOKS">HOOKS</a></h1> +<p class="Pp">This node type supports the following hooks:</p> +<dl class="Bl-tag"> + <dt id="annexA"><var class="Va">annexA</var></dt> + <dd>ITU Annex A LMI hook.</dd> + <dt id="annexD"><var class="Va">annexD</var></dt> + <dd>ANSI Annex D LMI hook.</dd> + <dt id="group4"><var class="Va">group4</var></dt> + <dd>Group-of-four LMI hook.</dd> + <dt id="auto0"><var class="Va">auto0</var></dt> + <dd>Auto-detection hook for DLCI 0.</dd> + <dt id="auto1023"><var class="Va">auto1023</var></dt> + <dd>Auto-detection hook for DLCI 1023.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="CONTROL_MESSAGES"><a class="permalink" href="#CONTROL_MESSAGES">CONTROL + MESSAGES</a></h1> +<p class="Pp">This node type supports the generic control messages, plus the + following:</p> +<dl class="Bl-tag"> + <dt id="NGM_LMI_GET_STATUS"><a class="permalink" href="#NGM_LMI_GET_STATUS"><code class="Dv">NGM_LMI_GET_STATUS</code></a></dt> + <dd>This command returns status information in a <code class="Dv">struct + nglmistat</code>: + <div class="Bd Pp Bd-indent Li"> + <pre>#define NGM_LMI_STAT_ARYSIZE (1024/8) + +struct nglmistat { + u_char proto[12]; /* Active proto (same as hook name) */ + u_char hook[12]; /* Active hook */ + u_char fixed; /* If set to fixed LMI mode */ + u_char autod; /* If currently auto-detecting */ + u_char seen[NGM_LMI_STAT_ARYSIZE]; /* DLCIs ever seen */ + u_char up[NGM_LMI_STAT_ARYSIZE]; /* DLCIs currently up */ +};</pre> + </div> + </dd> + <dt id="NGM_TEXT_STATUS"><a class="permalink" href="#NGM_TEXT_STATUS"><code class="Dv">NGM_TEXT_STATUS</code></a></dt> + <dd>This generic message returns is a human-readable version of the node + status.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="SHUTDOWN"><a class="permalink" href="#SHUTDOWN">SHUTDOWN</a></h1> +<p class="Pp">This node shuts down upon receipt of a + <code class="Dv">NGM_SHUTDOWN</code> control message, or when all hooks have + been disconnected.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE + ALSO</a></h1> +<p class="Pp"><a class="Xr">netgraph(4)</a>, + <a class="Xr">ng_frame_relay(4)</a>, <a class="Xr">ngctl(8)</a></p> +<p class="Pp"><cite class="Rs"><span class="RsT">ANSI T1.617-1991 Annex + D</span>.</cite></p> +<p class="Pp"><cite class="Rs"><span class="RsT">ITU-T Q.933 Digital Subscriber + Signaling System No. 1 - Signaling Specification for Frame Mode Basic Call + Control, Annex A</span>.</cite></p> +</section> +<section class="Sh"> +<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> +<p class="Pp">The <code class="Nm">ng_lmi</code> node type was implemented in + <span class="Ux">FreeBSD 4.0</span>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> +<p class="Pp"><span class="An">Julian Elischer</span> + <<a class="Mt" href="mailto:julian@FreeBSD.org">julian@FreeBSD.org</a>></p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">November 13, 2012</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |