htdocs/docs/man/FS/nas.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>FS::nas - Object methods for nas records</TITLE>
   4 <LINK REV="made" HREF="mailto:perl@packages.debian.org">
   5 </HEAD>
   6
   7 <BODY>
   8
   9 <A NAME="__index__"></A>
  10 <!-- INDEX BEGIN -->
  11
  12 <UL>
  13
  14         <LI><A HREF="#name">NAME</A></LI>
  15         <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  16         <LI><A HREF="#description">DESCRIPTION</A></LI>
  17         <LI><A HREF="#methods">METHODS</A></LI>
  18         <LI><A HREF="#version">VERSION</A></LI>
  19         <LI><A HREF="#bugs">BUGS</A></LI>
  20         <LI><A HREF="#see also">SEE ALSO</A></LI>
  21 </UL>
  22 <!-- INDEX END -->
  23
  24 <HR>
  25 <P>
  26 <H1><A NAME="name">NAME</A></H1>
  27 <P>FS::nas - Object methods for nas records</P>
  28 <P>
  29 <HR>
  30 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  31 <PRE>
  32   use FS::nas;</PRE>
  33 <PRE>
  34   $record = new FS::nas \%hash;
  35   $record = new FS::nas {
  36     'nasnum'  =&gt; 1,
  37     'nasip'   =&gt; '10.4.20.23',
  38     'nasfqdn' =&gt; 'box1.brc.nv.us.example.net',
  39   };</PRE>
  40 <PRE>
  41   $error = $record-&gt;insert;</PRE>
  42 <PRE>
  43   $error = $new_record-&gt;replace($old_record);</PRE>
  44 <PRE>
  45   $error = $record-&gt;delete;</PRE>
  46 <PRE>
  47   $error = $record-&gt;check;</PRE>
  48 <PRE>
  49   $error = $record-&gt;heartbeat($timestamp);</PRE>
  50 <P>
  51 <HR>
  52 <H1><A NAME="description">DESCRIPTION</A></H1>
  53 <P>An FS::nas object represents an Network Access Server on your network, such as
  54 a terminal server or equivalent.  FS::nas inherits from FS::Record.  The
  55 following fields are currently supported:</P>
  56 <DL>
  57 <DT><STRONG><A NAME="item_nasnum_%2D_primary_key">nasnum - primary key</A></STRONG><BR>
  58 <DD>
  59 <DT><STRONG><A NAME="item_nas_%2D_NAS_name">nas - NAS name</A></STRONG><BR>
  60 <DD>
  61 <DT><STRONG><A NAME="item_nasip_%2D_NAS_ip_address">nasip - NAS ip address</A></STRONG><BR>
  62 <DD>
  63 <DT><STRONG><A NAME="item_nasfqdn_%2D_NAS_fully%2Dqualified_domain_name">nasfqdn - NAS fully-qualified domain name</A></STRONG><BR>
  64 <DD>
  65 <DT><STRONG><A NAME="item_state">last - timestamp indicating the last instant the NAS was in a known
  66              state (used by the session monitoring).</A></STRONG><BR>
  67 <DD>
  68 </DL>
  69 <P>
  70 <HR>
  71 <H1><A NAME="methods">METHODS</A></H1>
  72 <DL>
  73 <DT><STRONG><A NAME="item_new">new HASHREF</A></STRONG><BR>
  74 <DD>
  75 Creates a new NAS.  To add the NAS to the database, see <A HREF="#insert">insert</A>.
  76 <P>Note that this stores the hash reference, not a distinct copy of the hash it
  77 points to.  You can ask the object for a copy with the <EM>hash</EM> method.</P>
  78 <P></P>
  79 <DT><STRONG><A NAME="item_insert">insert</A></STRONG><BR>
  80 <DD>
  81 Adds this record to the database.  If there is an error, returns the error,
  82 otherwise returns false.
  83 <P></P>
  84 <DT><STRONG><A NAME="item_delete">delete</A></STRONG><BR>
  85 <DD>
  86 Delete this record from the database.
  87 <P></P>
  88 <DT><STRONG><A NAME="item_replace_OLD_RECORD">replace OLD_RECORD</A></STRONG><BR>
  89 <DD>
  90 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  91 returns the error, otherwise returns false.
  92 <P></P>
  93 <DT><STRONG><A NAME="item_check">check</A></STRONG><BR>
  94 <DD>
  95 Checks all fields to make sure this is a valid example.  If there is
  96 an error, returns the error, otherwise returns false.  Called by the insert
  97 and replace methods.
  98 <P></P>
  99 <DT><STRONG><A NAME="item_heartbeat">heartbeat TIMESTAMP</A></STRONG><BR>
 100 <DD>
 101 Updates the timestamp for this nas
 102 <P></P></DL>
 103 <P>
 104 <HR>
 105 <H1><A NAME="version">VERSION</A></H1>
 106 <P>$Id: nas.html,v 1.1 2001-04-23 12:41:57 ivan Exp $</P>
 107 <P>
 108 <HR>
 109 <H1><A NAME="bugs">BUGS</A></H1>
 110 <P>
 111 <HR>
 112 <H1><A NAME="see also">SEE ALSO</A></H1>
 113 <P><A HREF=".././FS/Record.html">the FS::Record manpage</A>, schema.html from the base documentation.</P>
 114
 115 </BODY>
 116
 117 </HTML>