Difference between revisions of "Freeside:4:Documentation:Developer/FS/nas"

Latest revision as of 07:25, 18 November 2015

NAME

FS::nas - Object methods for nas records

SYNOPSIS

 use FS::nas;

 $record = new FS::nas \%hash;
 $record = new FS::nas { 'column' => 'value' };

 $error = $record->insert;

 $error = $new_record->replace($old_record);

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::nas object represents a RADIUS client. FS::nas inherits from FS::Record. The following fields are currently supported:

nasnum - primary key; nasname - "NAS name", i.e. IP address; shortname - short descriptive name; type - the equipment vendor; ports; secret - the authentication secret for this client; server - virtual server name (optional); community; description - a longer descriptive name; svcnum - the FS::svc_broadband record that 'owns' this device

METHODS

new HASHREF

Creates a new NAS. To add the NAS to the database, see "insert".

Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the hash method.

insert

Adds this record to the database. If there is an error, returns the error, otherwise returns false.

delete

Delete this record from the database and remove all linked exports.

replace OLD_RECORD

Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.

To change the list of linked exports, see the export_nas method.

check

Checks all fields to make sure this is a valid NAS. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

part_export

Return all FS::part_export objects to which this NAS is being exported.

BUGS

SEE ALSO

FS::Record, schema.html from the base documentation.