pfSense-pkg-RESTAPI

FreeRADIUSCommonModelTraits

Defines a set of Field declarations and helpers that are shared between the FreeRADIUS user-style Models (FreeRADIUSUser, FreeRADIUSMAC). Both pfSense FreeRADIUS user and authorized-MAC entries expose the same set of RADIUS attribute fields (description, framed addressing, VLAN, time/quota, bandwidth, additional RADIUS attributes, etc.) — the only difference is the internal pfSense config key prefix (`varusers...` vs `varmacs...`) and a small naming quirk on the WISPr redirection URL field.

Table of Contents

Properties

$acct_interim_interval  : IntegerField
$amount_of_time  : IntegerField
$check_items_additional_options  : StringField
$description  : StringField
$expiration  : StringField
$framed_ip_address  : StringField
$framed_ip_netmask  : StringField
$framed_ipv6_address  : StringField
$framed_ipv6_route  : StringField
$framed_route  : StringField
$login_time  : StringField
$max_bandwidth_down  : IntegerField
$max_bandwidth_up  : IntegerField
$max_total_octets  : IntegerField
$max_total_octets_time_range  : StringField
$point_of_time  : StringField
$reply_items_additional_options  : StringField
$session_timeout  : IntegerField
$simultaneous_connect  : IntegerField
$top_additional_options  : StringField
$vlan_id  : StringField
$wispr_redirection_url  : StringField

Methods

init_freeradius_common_fields()  : void
Defines the set of Fields that are shared between the FreeRADIUSUser and FreeRADIUSMAC models.

Properties

Methods

init_freeradius_common_fields()

Defines the set of Fields that are shared between the FreeRADIUSUser and FreeRADIUSMAC models.

protected init_freeradius_common_fields(string $prefix[, string $url_field_suffix = 'wisprredirectionurl' ]) : void
Parameters
$prefix : string

The internal pfSense config key prefix used by the consuming Model (e.g. varusers for users or varmacs for MAC entries).

$url_field_suffix : string = 'wisprredirectionurl'

The suffix appended to $prefix to compute the internal_name for the WISPr redirection URL field. The pfSense package uses wisprredirectionurl for users and the (typo'd) swisprredirectionurl for MACs, so this is overridable.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results