X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=httemplate%2Fdocs%2Fman%2FFS%2Fsvc_acct.html;h=9c41db3f0eb84aa23ac254ed84147559dc887343;hp=81bc118dfaac92fe8a555b2174e4dc69e6eda0a6;hb=6991d4986df7fb3a6c7c49b5ae1b3713e87a16c4;hpb=f02dd9b0e5042ef000d9338089eed50988d48914 diff --git a/httemplate/docs/man/FS/svc_acct.html b/httemplate/docs/man/FS/svc_acct.html index 81bc118df..9c41db3f0 100644 --- a/httemplate/docs/man/FS/svc_acct.html +++ b/httemplate/docs/man/FS/svc_acct.html @@ -49,6 +49,18 @@ $error = $record->cancel; 
   %hash = $record->radius;
+
+  %hash = $record->radius_reply;
+
+  %hash = $record->radius_check;
+
+  $domain = $record->domain;
+
+  $svc_domain = $record->svc_domain;
+
+  $email = $record->email;
+
+  $seconds_since = $record->seconds_since($timestamp);

DESCRIPTION

@@ -77,8 +89,14 @@ FS::svc_Common. The following fields are currently supported:

slipip - IP address
+
seconds -
+
+
domsvc - svcnum from svc_domain
+
radius_Radius_Attribute - Radius-Attribute
+
domsvc - service number of svc_domain with which to associate
+

@@ -96,7 +114,8 @@ otherwise returns false. defined. An FS::cust_svc record will be created and inserted.

If the configuration value (see the FS::Conf manpage) shellmachine exists, and the username, uid, and dir fields are defined, the command(s) specified in -the shellmachine-useradd configuration are exectued on shellmachine via ssh. +the shellmachine-useradd configuration are added to the job queue (see +the FS::queue manpage and the freeside-queued manpage) to be exectued on shellmachine via ssh. This behaviour can be surpressed by setting $FS::svc_acct::nossh_hack true. If the shellmachine-useradd configuration file does not exist,

@@ -108,6 +127,7 @@ it empty,

 
is the default instead.  Otherwise the contents of the file are treated as
 a double-quoted perl string, with the following variables available:
 $username, $uid, $gid, $dir, and $shell.

+
(TODOC: cyrus config file, the FS::queue manpage and the freeside-queued manpage)

 

 
delete

 

@@ -116,7 +136,8 @@ error, otherwise returns false.
 
The corresponding FS::cust_svc record will be deleted as well.

 
If the configuration value (see the FS::Conf manpage) shellmachine exists, the
 command(s) specified in the shellmachine-userdel configuration file are
-executed on shellmachine via ssh.  This behavior can be surpressed by setting
+added to the job queue (see the FS::queue manpage and the freeside-queued manpage) to be executed
+on shellmachine via ssh.  This behavior can be surpressed by setting
 $FS::svc_acct::nossh_hack true.  If the shellmachine-userdel configuration
 file does not exist,

 
@@ -128,6 +149,7 @@ is empty,

 
is the default instead.  Otherwise the contents of the file are treated as a
 double-quoted perl string, with the following variables available:
 $username and $dir.

+
(TODOC: cyrus config file)

 

 
replace OLD_RECORD

 

@@ -135,9 +157,10 @@ Replaces OLD_RECORD with this one in the database.  If there is an error,
 returns the error, otherwise returns false.
 
If the configuration value (see the FS::Conf manpage) shellmachine exists, and the 
 dir field has changed, the command(s) specified in the shellmachine-usermod
-configuraiton file are executed on shellmachine via ssh.  This behavior can
+configuraiton file are added to the job queue (see the FS::queue manpage and
+the freeside-queued manpage) to be executed on shellmachine via ssh.  This behavior can
 be surpressed by setting $FS::svc-acct::nossh_hack true.  If the
-shellmachine-userdel configuration file does not exist or is empty, :

+shellmachine-userdel configuration file does not exist or is empty,

 
   [ -d $old_dir ] && mv $old_dir $new_dir || (
     chmod u+t $old_dir;
@@ -148,8 +171,8 @@ shellmachine-userdel configuration file does not exist or is empty, :

     chown -R $uid.$gid $new_dir;
     rm -rf $old_dir
   )

-
is executed on shellmachine via ssh.  This behaviour can be surpressed by
-setting $FS::svc_acct::nossh_hack true.

+
is the default.  This behaviour can be surpressed by setting
+$FS::svc_acct::nossh_hack true.

 

 
suspend

 

@@ -193,11 +216,42 @@ Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
 check attributes of this record.
 
Accessing RADIUS attributes directly is not supported and will break in the
 future.

-

+

+
domain

+

+Returns the domain associated with this account.
+

+
svc_domain

+

+Returns the FS::svc_domain record for this account's domain (see
+the FS::svc_domain manpage.
+

+
cust_svc

+

+Returns the FS::cust_svc record for this account (see the FS::cust_svc manpage).
+
sub cust_svc {
+  my $self = shift;
+  qsearchs( 'cust_svc', { 'svcnum' => $self->svcnum } );
+}

+

+
email

+

+Returns an email address associated with the account.
+

+
seconds_since TIMESTAMP

+

+Returns the number of seconds this account has been online since TIMESTAMP.
+See the FS::session manpage
+
TIMESTAMP is specified as a UNIX timestamp; see perlfunc/``time''.  Also see
+the Time::Local manpage and the Date::Parse manpage for conversion functions.

+

+
ssh

+

+
 

 

 
VERSION

-
$Id: svc_acct.html,v 1.1 2001-07-30 07:36:03 ivan Exp $

+
$Id: svc_acct.html,v 1.2 2002-01-29 16:33:16 ivan Exp $

 

 

 
BUGS

@@ -210,8 +264,10 @@ counterintuitive.

 

 

 
SEE ALSO

-
the FS::svc_Common manpage, the FS::Record manpage, the FS::Conf manpage, the FS::cust_svc manpage,
-the FS::part_svc manpage, the FS::cust_pkg manpage, the Net::SSH manpage, ssh, the FS::svc_acct_pop manpage,
+
the FS::svc_Common manpage, edit/part_svc.cgi from an installed web interface,
+export.html from the base documentation, the FS::Record manpage, the FS::Conf manpage,
+the FS::cust_svc manpage, the FS::part_svc manpage, the FS::cust_pkg manpage, the FS::queue manpage,
+the freeside-queued manpage), the Net::SSH manpage, ssh, the FS::svc_acct_pop manpage,
 schema.html from the base documentation.