Package sspPlugin

CORBA-based plug-in SPI that allows you to implement external SAE plug-ins in any language that supports CORBA. More...

Classes

union  AttributeUnion
 Structure used to pass event attribute values to plug-ins. More...
struct  NameValue
 List of attributes in NameValue format. More...
struct  SubscriptionInfo
 Data structure for subscription information. More...
struct  DirectoryAccessInfo
 Data structure for information that the plug-in uses to access the directory. More...
interface  PluginContext
 Generic callback interface from the plug-in to the SAE. More...
interface  PluginInterface
 Basic plug-in interface. More...
interface  SyncPluginInterface
 Stateful plug-in interface; extension of the basic plug-in interface. More...
interface  StateSyncPlugin
 State synchronization plug-in interface; extension of the stateful plug-in interface. More...

Typedefs

typedef sequence< NameValueNameValueList
 Event attributes are passed to the PluginInterface.authorize() and PluginInterface.track() methods in the form of a NameValue list.

Enumerations

enum  PluginEventType {
  PE_AUTH_USER,
  PE_AUTH_SERVICE,
  PE_AUTH_SUBSCRIPTION,
  PE_START_USER,
  PE_STOP_USER,
  PE_INTERIM_USER,
  PE_START_SERVICE,
  PE_INTERIM_SERVICE,
  PE_STOP_SERVICE,
  PE_START_INTERFACE,
  PE_INTERIM_INTERFACE,
  PE_STOP_INTERFACE,
  PE_AUTH_DHCP,
  PE_no_event
}
 

Types of events that the SAE sends to the plug-in.

More...
enum  PluginAttribute {
  PA_SSP_HOST,
  PA_ROUTER_NAME,
  PA_INTERFACE_NAME,
  PA_INTERFACE_ALIAS,
  PA_INTERFACE_DESCR,
  PA_PORT_ID,
  PA_USER_IP_ADDRESS,
  PA_LOGIN_NAME,
  PA_ACCOUNTING_ID,
  PA_AUTH_USER_ID,
  PA_IF_RADIUS_CLASS,
  PA_IF_SESSION_ID,
  PA_SERVICE_BUNDLE,
  PA_USER_DN,
  PA_UID,
  PA_DOMAIN,
  PA_RETAILER_DN,
  PA_PASSWORD,
  PA_SERVICE_NAME,
  PA_SERVICE_SCOPE,
  PA_RADIUS_CLASS,
  PA_EVENT_TIME,
  PA_SESSION_ID,
  PA_TERMINATE_CAUSE,
  PA_SESSION_TIME,
  PA_IN_OCTETS,
  PA_OUT_OCTETS,
  PA_IN_PACKETS,
  PA_OUT_PACKETS,
  PA_SESSION_TIMEOUT,
  PA_NAS_IP,
  PA_USER_MAC_ADDRESS,
  PA_DOWNSTREAM_BANDWIDTH,
  PA_UPSTREAM_BANDWIDTH,
  PA_REPLY_MESSAGE,
  PA_SERVICE_SESSION_NAME,
  PA_SERVICE_SESSION_TAG,
  PA_DHCP_PACKET,
  PA_USER_TYPE,
  PA_USER_RADIUS_CLASS,
  PA_USER_SESSION_ID,
  PA_PRIMARY_USER_NAME,
  PA_SESSION_VOLUME_QUOTA,
  PA_SUBSCRIPTION_NAME,
  PA_LOAD_SERVICES,
  PA_LOGIN_ID,
  PA_POOL_NAME,
  PA_AUTH_VIRTUAL_ROUTER_NAME,
  PA_IF_INDEX,
  PA_EVENT_TIME_MILLISECOND,
  PA_NAS_PORT,
  PA_OPERATIONAL,
  PA_IDLE_TIMEOUT,
  PA_USER_INET_ADDRESS,
  PA_NAS_INET_ADDRESS,
  PA_AGGR_SESSION_ID,
  PA_AGGR_LOGIN_NAME,
  PA_AGGR_USER_DN,
  PA_AGGR_USER_INET_ADDRESS,
  PA_AGGR_ACCOUNTING_ID,
  PA_AGGR_AUTH_USER_ID,
  PA_PROPERTY,
  PA_ACCT_INTERIM_TIME,
  PA_SUBSTITUTION,
  PA_TERMINATE_TIME,
  PA_ROUTER_TYPE,
  PA_PCMM_REQUEST_TYPE,
  PA_PCMM_AM_ID,
  PA_PCMM_BC_ID,
  PA_INTERFACE_SPEED,
  PA_ACCESS_MODE,
  PA_ACCESS_UPSTREAM_RATE,
  PA_ACCESS_DOWNSTREAM_RATE,
  PA_MIN_UPSTREAM_RATE,
  PA_MIN_DOWNSTREAM_RATE,
  PA_ATTAINABLE_UPSTREAM_RATE,
  PA_ATTAINABLE_DOWNSTREAM_RATE,
  PA_MAXIMUM_UPSTREAM_RATE,
  PA_MAXIMUM_DOWNSTREAM_RATE,
  PA_MINIMUM_LOW_POWER_UPSTREAM_RATE,
  PA_MINIMUM_LOW_POWER_DOWNSTREAM_RATE,
  PA_MAXIMUM_INTERLEAVING_UPSTREAM_DELAY,
  PA_ACTUAL_INTERLEAVING_UPSTREAM_DELAY,
  PA_MAXIMUM_INTERLEAVING_DOWNSTREAM_DELAY,
  PA_ACTUAL_INTERLEAVING_DOWNSTREAM_DELAY,
  PA_DSL_LINE_STAT,
  PA_USER_SESSION_HANDLE,
  PA_TUNNEL_ID,
  PA_TUNNEL_SESSION_ID,
  PA_LAC_IP,
  PA_CALLING_STATION_ID,
  PA_USER_PROPERTY,
  PA_VPN_ID,
  PA_LOCAL_QOS_PROFILE,
  PA_IDLE_TIMEOUT_INPUT,
  PA_IDLE_TIMEOUT_OUTPUT,
  PA_REMOTE_TUNNEL_INET_ADDRESS,
  PA_LOCAL_TUNNEL_INET_ADDRESS,
  PA_USER_IP_MASK,
  PA_FRAMED_IPV6_PREFIX,
  PA_DELEGATED_IPV6_PREFIX,
  PA_SERVICE_IDENTIFIER,
  PA_EVENT_TRIGGER,
  PA_TDF_APP_ID,
  PA_TDF_APP_INSTANCE_ID,
  PA_RATING_GROUP,
  PA_TOTAL_OCTETS,
  PA_IPV6_IN_OCTETS,
  PA_IPV6_OUT_OCTETS,
  PA_IPV6_IN_PACKETS,
  PA_IPV6_OUT_PACKETS,
  PA_IPV6_TOTAL_OCTETS,
  PA_last
}
 

Plug-in attributes that the SAE can send to the plug-in.

More...
enum  PluginAttributeType {
  PAT_LONG,
  PAT_LONG_LONG,
  PAT_STRING,
  PAT_OPAQUE
}
 

Possible encoding types of plug-in attribute types.

More...

Detailed Description

CORBA-based plug-in SPI that allows you to implement external SAE plug-ins in any language that supports CORBA.


Typedef Documentation

Event attributes are passed to the PluginInterface.authorize() and PluginInterface.track() methods in the form of a NameValue list.


Enumeration Type Documentation

Plug-in attributes that the SAE can send to the plug-in.

When you configure a plug-in instance in the SAE, you should specify the attribute types that the SAE is allowed to send to the plug-in, as well as attribute types that can be returned by authorization plug-ins. The configuration property is "Plugin.<name>.attr," and it contains a comma-separated list of plug-in names as defined in this enumeration.

You should specify the list of attributes because the plug-in interface can change between versions of the SDX software. If a plug-in is configured to receive all possible event attributes, it will likely break if the SAE software is upgraded and the interface or the plug-in implementation is not recompiled.

Enumerator:
PA_SSP_HOST 

Name of the host on which the SAE is installed.

  • Type of attribute - PAT_STRING
  • Types of associated events - All
PA_ROUTER_NAME 

Name of the virtual router, in the format <virtualRouter>@<router>.

  • Type of attribute - PAT_STRING
  • Types of associated events - All
PA_INTERFACE_NAME 

Name of the interface, such as fastethernet 3/1.

  • Type of attribute - PAT_STRING
  • Types of associated events - All
PA_INTERFACE_ALIAS 

Alias of the interface that is configured on the JUNOSe router with the interface ip description command.

  • Type of attribute - PAT_STRING
  • Types of associated events - All
PA_INTERFACE_DESCR 

Alternative name of the interface that SNMP uses.

  • Type of attribute - PAT_STRING
  • Types of associated events - All
PA_PORT_ID 

Identifier of the VLAN or virtual circuit; virtual circuit takes the format <VPI>|<VCI>.

This attribute is not supported on JUNOS routing platforms.

  • Type of attribute - PAT_STRING
  • Types of associated events - All
PA_USER_IP_ADDRESS 

IP address of the PPP subscriber.

  • Type of attribute - PAT_LONG
  • Types of associated events - All
PA_LOGIN_NAME 

Subscriber's login name.

  • The format of the login name depends on the configuration of the login name parser.
  • Type of attribute - PAT_STRING
  • Types of associated events - All
PA_ACCOUNTING_ID 

Value of the LDAP attribute accountingUserId.

  • Type of attribute - PAT_STRING
  • Types of associated events - All
PA_AUTH_USER_ID 

Identifier that the subscriber uses for authentication.

  • Type of attribute - PAT_STRING
  • Types of associated events - Tracking
PA_IF_RADIUS_CLASS 

RADIUS class attribute of the underlying router interface.

This attribute can occur multiple times. This attribute is not supported on JUNOS routing platforms.

  • Type of attribute - PAT_STRING
  • Types of associated events - All
PA_IF_SESSION_ID 

Identifier for RADIUS accounting of the underlying router interface.

This attribute is not supported on JUNOS routing platforms.

  • Type of attribute - PAT_STRING
  • Types of associated events - All
PA_SERVICE_BUNDLE 

Service Bundle RADIUS VSA that a user authorization plug-in returns to the SAE.

  • Type of attribute - PAT_STRING
  • Types of associated events - UserAuthorization
PA_USER_DN 

DN of the user profile.

  • Type of attribute - PAT_STRING
  • Types of associated events - ALL
PA_UID 

Subscriber ID used for secondary authentication.

  • Type of attribute - PAT_STRING
  • Types of associated events - Authorization
PA_DOMAIN 

Domain for secondary authentication.

  • Type of attribute - PAT_STRING
  • Types of associated events - Authorization
PA_RETAILER_DN 

Retailer DN associated with the domain.

  • Type of attribute - PAT_STRING
  • Types of associated events - Authorization
PA_PASSWORD 

Password for secondary authentication.

  • Type of attribute - PAT_STRING
  • Types of associated events - Authorization
PA_SERVICE_NAME 

Name of service, in the format: service=<SERVICE_NAME>, <BASE_DN>.

  • Type of attribute - PAT_STRING
  • Types of associated events - ServiceAuthorization, SubscriptionAuthorization
PA_SERVICE_SCOPE 

List of service scopes.

  • Type of attribute - PAT_STRING
  • Types of associated events - ServiceTracking, ServiceAuthorization
PA_RADIUS_CLASS 

RADIUS class attribute from the service definition.

This attribute can occur multiple times.

  • Type of attribute - PAT_STRING
  • Types of associated events - UserTracking, ServiceTracking, ServiceAuthorization
PA_EVENT_TIME 

Number of seconds since midnight 1970-01-01 UTC.

  • Type of attribute - PAT_LONG
  • Types of associated events - All
PA_SESSION_ID 

accounting attributes

RADIUS session ID.

  • Type of attribute - PAT_STRING
  • Types of associated events - ALL
PA_TERMINATE_CAUSE 

Cause of RADIUS termination.

  • Type of attribute - PAT_LONG
  • Types of associated events - UserTracking, ServiceTracking
PA_SESSION_TIME 

Length of session in seconds.

  • Type of attribute - PAT_LONG
  • Types of associated events - UserTracking, ServiceTracking
PA_IN_OCTETS 

Number of 64-bit upstream octets (user -> network).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - UserTracking, ServiceTracking
PA_OUT_OCTETS 

Number of 64-bit downstream octets (network -> user).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - UserTracking, ServiceTracking
PA_IN_PACKETS 

Number of 64-bit upstream packets (user -> network).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - UserTracking, ServiceTracking
PA_OUT_PACKETS 

Number of 64-bit downstream packets (network -> user).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - UserTracking, ServiceTracking
PA_SESSION_TIMEOUT 

Maximum length of the session in seconds.

This attribute can be returned by an authorization plug-in.

  • Type of attribute - PAT_LONG
  • Types of associated events - UserTracking, UserAuthorization, ServiceAuthorization
PA_NAS_IP 

IP address for RADIUS communication.

This attribute is not supported on JUNOS routing platforms.

  • Type of attribute - PAT_LONG
  • Types of associated events - All
PA_USER_MAC_ADDRESS 

MAC address of the DHCP subscriber.

This attribute is not supported on JUNOS routing platforms.

  • Type of attribute - PAT_STRING
  • Types of associated events - All
PA_DOWNSTREAM_BANDWIDTH 

Downstream bandwidth for the service.

  • Type of attribute - PAT_LONG
  • Types of associated events - ServiceAuthorization, ServiceTracking
PA_UPSTREAM_BANDWIDTH 

Upstream bandwidth for the service.

  • Type of attribute - PAT_LONG
  • Types of associated events - ServiceAuthorization, ServiceTracking
PA_REPLY_MESSAGE 

Set message string that a plug-in returns to the SAE during authorization.

Since:
4.0
  • Type of attribute - PAT_STRING
  • Types of associated events - All Authorization
PA_SERVICE_SESSION_NAME 

Name of service session.

  • Type of attribute - PAT_STRING
  • Types of associated events - ServiceAuthorization, ServiceTracking
PA_SERVICE_SESSION_TAG 

Tag of service session.

  • Type of attribute - PAT_STRING
  • Types of associated events - ServiceAuthorization, ServiceTracking
PA_DHCP_PACKET 

Contents of the DHCP discover request, in the format:

  • First 4 octets - gateway IP address (giaddr field)
  • Remaining octets - DHCP options; for more information, see RFC 2251

This attribute is not supported on JUNOS routing platforms.

  • Type of attribute - PAT_OPAQUE
  • Types of associated events - All
PA_USER_TYPE 

Type of subscriber.

  • Type of attribute - PAT_STRING
  • Types of associated events - All
PA_USER_RADIUS_CLASS 

RADIUS class of the subscriber session for a service.

This attribute can occur multiple times, and can be returned by an authorization plug-in.

  • Type of attribute - PAT_STRING
  • Types of associated events - All
PA_USER_SESSION_ID 

Identifier of RADIUS sessions for subscriber sessions.

  • Type of attribute - PAT_STRING
  • Types of associated events - ServiceAuthorization
PA_PRIMARY_USER_NAME 

pppLoginName or publicDhcpUserName.

Since:
4.0.1 This attribute is not supported on JUNOS routing platforms.
  • Type of attribute - PAT_STRING
  • Types of associated events - All
PA_SESSION_VOLUME_QUOTA 

Total volume of data in megabytes (MB) that a subscriber is allowed to upload or download.

Since:
4.1 The format is <downstream quota>;<upstream quota>. This attribute can be returned by an authorization plug-in.
  • Type of attribute - PAT_STRING
  • Types of associated events - ServiceAuthorization
PA_SUBSCRIPTION_NAME 

Name of the subscription, in the format subscription=<serviceName>%<subscriptionId>.

  • Type of attribute - PAT_STRING
  • Types of associated events - UserTracking, ServiceTracking
PA_LOAD_SERVICES 

List of services to which the subscriber has access.

Authorization plug-ins can return this attribute; other plug-ins and the SAE do not send this attribute. The SAE parses this value with a regular expression that you configure in the subscription parser.

  • Type of attribute - PAT_STRING
  • Types of associated events - UserAuthorization
PA_LOGIN_ID 

Subscriber's login identifier in the format that the subscriber enters it, such as <domainName>/<subscriberName>.

Since:
4.0.1
  • Type of attribute - PAT_STRING
  • Types of associated events - All Authorization
PA_POOL_NAME 

Name of the address pool on the JUNOSe router from which an address is assigned.

Since:
4.2 This attribute can be returned by an authorization plug-in. It is not supported on JUNOS routing platforms.
  • Type of attribute - PAT_STRING
  • Types of associated events - DHCPAuthorization
PA_AUTH_VIRTUAL_ROUTER_NAME 

Name of the JUNOSe virtual router on which the address pool is located, in the format <virtualRouter>@<hostname>.

This attribute is not supported on JUNOS routing platforms.

  • Type of attribute - PAT_STRING
  • Types of associated events - DHCPAuthorization
PA_IF_INDEX 

SNMP index of interface.

This attribute is not supported on JUNOS routing platforms.

  • Type of attribute - PAT_LONG
  • Types of associated events - InterfaceTracking
PA_EVENT_TIME_MILLISECOND 

Number of milliseconds since midnight 1970-01-01 UTC.

Since:
4.3
  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - All
PA_NAS_PORT 

Numeric identifier that the router uses to identify the interface to RADIUS.

  • Type of attribute - PAT_LONG
  • Types of associated events - ALL
PA_OPERATIONAL 

Flag that identifies whether an interface was operational at the time of the tracking event.

0=not operational, 1=op

  • Type of attribute - PAT_LONG
  • Types of associated events - Tracking
PA_IDLE_TIMEOUT 

Idle timeout for the service session that is set by the authorization plug-in.

  • Type of attribute - PAT_LONG
  • Types of associated events - Authorization
PA_USER_INET_ADDRESS 

IP address of the subscriber that uses a byte array instead of an integer.

Since:
5.1 For IPv4 this attribute is equivalent to the PA_USER_IP_ADDRESS attribute, but it allows extension to IPv6 (which is not yet supported in the SDX software).
  • Type of attribute - PAT_OPAQUE; for IPv4: 4 octets in network byte order; for IPv6: 16 octets in network byte order (not yet supported).
  • Types of associated events - All
PA_NAS_INET_ADDRESS 

IP address of the router that uses a byte array instead of an integer.

For IPv4 this attribute is equivalent to PA_NAS_IP, but it allows extension to IPv6 (which is not yet supported in the SDX software).

  • Type of attribute - PAT_OPAQUE; for IPv4: 4 octets in network byte order; for IPv6: 16 octets in network byte order (not yet supported).
  • Types of associated events - All
PA_AGGR_SESSION_ID 

Accounting session ID of the aggregate service session.

Since:
5.1 Includes the ID of the SAE that started the session.
  • Type of attribute - PAT_STRING
  • Types of associated events - ServiceTracking
PA_AGGR_LOGIN_NAME 

Login name of the subscriber who started the aggregate service session.

  • Type of attribute - PAT_STRING
  • Types of associated events - ServiceTracking
PA_AGGR_USER_DN 

DN of user profile of the subscriber who started the aggregate service session.

  • Type of attribute - PAT_STRING
  • Types of associated events - ServiceTracking
PA_AGGR_USER_INET_ADDRESS 

IP address of the subscriber who started the aggregate service session.

  • Type of attribute - PAT_OPAQUE; for IPv4: 4 octet in network byte order; for IPv6: 16 octet in network byte order (not yet supported).
  • Types of associated events - ServiceTracking
PA_AGGR_ACCOUNTING_ID 

Accounting ID of the subscriber who started the aggregate service session.

  • Type of attribute - PAT_STRING
  • Types of associated events - ServiceTracking
PA_AGGR_AUTH_USER_ID 

User ID that was used to authenticate the aggregate service session.

  • Type of attribute - PAT_STRING
  • Types of associated events - ServiceTracking
PA_PROPERTY 

Session property, in the form <name>=<value>, can be set by a service or user authorization plug-in.

This attribute can be returned multiple times. Each value contains a different property.

  • Type of attribute - PAT_STRING
  • Types of associated events - All
PA_ACCT_INTERIM_TIME 

Accounting interim time set by a service or user authorization plug-in.

This value overrides the global accounting interim time and the accounting interim time set in a service definition.

  • Type of attribute - PAT_LONG
  • Types of associated events - ServiceAuthorization
PA_SUBSTITUTION 

Parameter substitution set by a service or user authorization plug-in.

This attribute can be returned multiple times. Each value contains a different substitution. Substitutions can be set only for service sessions.

  • Type of attribute - PAT_STRING
  • Types of associated events - ServiceAuthorization or UserAuthorization
PA_TERMINATE_TIME 

Time to end the user session that is set by a user authorization plug-in.

The time is in ISO 8601 format as one of the following:

  • YYYY-MM-DDThh:mm:ssTZT (Note that the T between DD and hh is a literal value and must appear in this space.)
  • hh:mm:ssTZD

hh is specified in a 24 hour format. For example, 1 PM would be identified as 13:00.

TZD (time zone) is specified as the offset from Universal Time Coordinate (UTC). If no time zone is indicated, the local time zone is used.

If the date is not specified, the time indicates the next occurrence of that time on either the same day or the next day.

For example, to specify the time as 12 PM on December 1, 2004, Eastern Standard Time (UTC-5): 2004-12-01T12:00:00-05:00

  • Type of attribute - PAT_STRING
  • Types of associated events - UserAuthorization
PA_ROUTER_TYPE 

Type of the router driver.

  • Type of attribute - PAT_STRING
  • Types of associated events - All
PA_PCMM_REQUEST_TYPE 

PCMM policy event type.

  • Type of attribute - PAT_LONG
  • Types of associated events - RksTracking
PA_PCMM_AM_ID 

PCMM Application Manager ID.

  • Type of attribute - PAT_LONG
  • Types of associated events - RksTracking
PA_PCMM_BC_ID 

PCMM Billing Correlation ID.

  • Type of attribute - PAT_OPAQUE
  • Types of associated events - RksTracking
PA_INTERFACE_SPEED 

Speed of interface.

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - All
PA_ACCESS_MODE 

L2C access mode.

  • Type of attribute - PAT_LONG
  • Possible values:
  • 0 = unspecified,
  • 1 = adsl1,
  • 2 = adsl2,
  • 3 = adsl2plus,
  • 4 = vdsl1,
  • 5 = vdsl2,
  • 6 = sdsl,
  • 7 = unknown
  • Types of associated events - InterfaceTracking
PA_ACCESS_UPSTREAM_RATE 

L2C upstream rate, in bits/s (0 if unspecified).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - InterfaceTracking
PA_ACCESS_DOWNSTREAM_RATE 

L2C downstream rate, in bits/s (0 if unspecified).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - InterfaceTracking
PA_MIN_UPSTREAM_RATE 

L2C minimum upstream rate, in bits/s (0 if unspecified).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - InterfaceTracking
PA_MIN_DOWNSTREAM_RATE 

L2C minimum downstream rate, in bits/s (0 if unspecified).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - InterfaceTracking
PA_ATTAINABLE_UPSTREAM_RATE 

L2C attainable upstream rate, in bits/s (0 if unspecified).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - InterfaceTracking
PA_ATTAINABLE_DOWNSTREAM_RATE 

L2C attainable downstream rate, in bits/s (0 if unspecified).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - InterfaceTracking
PA_MAXIMUM_UPSTREAM_RATE 

L2C maximum upstream rate, in bits/s (0 if unspecified).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - InterfaceTracking
PA_MAXIMUM_DOWNSTREAM_RATE 

L2C maximum downstream rate, in bits/s (0 if unspecified).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - InterfaceTracking
PA_MINIMUM_LOW_POWER_UPSTREAM_RATE 

L2C minimum low power upstream rate, in bits/s (0 if unspecified).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - InterfaceTracking
PA_MINIMUM_LOW_POWER_DOWNSTREAM_RATE 

L2C minimum low power downstream rate, in bits/s (0 if unspecified).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - InterfaceTracking
PA_MAXIMUM_INTERLEAVING_UPSTREAM_DELAY 

L2C maximum interleaving upstream rate, in milliseconds (0 if unspecified).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - InterfaceTracking
PA_ACTUAL_INTERLEAVING_UPSTREAM_DELAY 

L2C actual interleaving upstream rate, in milliseconds (0 if unspecified).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - InterfaceTracking
PA_MAXIMUM_INTERLEAVING_DOWNSTREAM_DELAY 

L2C maximum interleaving downstream rate, in milliseconds (0 if unspecified).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - InterfaceTracking
PA_ACTUAL_INTERLEAVING_DOWNSTREAM_DELAY 

L2C actual interleaving downstream rate, in milliseconds (0 if unspecified).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - InterfaceTracking
PA_DSL_LINE_STAT 

L2C DLS line status.

  • Type of attribute - PAT_LONG
  • Possible values:
  • 0 = unspecified,
  • 1 = showtime,
  • 2 = idle,
  • 3 = silent
  • Types of associated events - InterfaceTracking
PA_USER_SESSION_HANDLE 

includes vr name and RADIUS session ID.

  • Type of attribute - PAT_STRING
  • Types of associated events - ALL
PA_TUNNEL_ID 

L2TP support SRC 3.1.

Identifier of LAC tunnel id for subscriber sessions.

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - UserTracking
PA_TUNNEL_SESSION_ID 

Identifier of LAC tunnel session id for subscriber sessions.

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - UserTracking
PA_LAC_IP 

LAC ip address.

  • Type of attribute - PAT_LONG
  • Types of associated events - UserTracking
PA_CALLING_STATION_ID 

Calling-Station-Id for RADIUS authenticated sessions

  • Type of attribute - PAT_STRING
  • Types of associated events - All.
PA_USER_PROPERTY 

Session property of the subscriber session, in the form <name>=<value> This attribute can be returned multiple times.

Each value contains a different property.

  • Type of attribute - PAT_STRING
  • Types of associated events - ServiceAuthorization, ServiceTracking
PA_VPN_ID 

VPN-ID

  • Type of attribute - PAT_STRING
  • Types of associated events - All.
PA_LOCAL_QOS_PROFILE 

local qos profile, in the form <name>=<value> This attribute can be returned multiple times.

Each value contains a different qos profile layer and name.

  • Type of attribute - PAT_STRING
  • Types of associated events - All
PA_IDLE_TIMEOUT_INPUT 

Input idle timeout for the service session that is set by the authorization plug-in.

  • Type of attribute - PAT_LONG
  • Types of associated events - Authorization
PA_IDLE_TIMEOUT_OUTPUT 

Output idle timeout for the service session that is set by the authorization plug-in.

  • Type of attribute - PAT_LONG
  • Types of associated events - Authorization
PA_REMOTE_TUNNEL_INET_ADDRESS 

InetAddress of the far end of an L2TP tunnel.

If the subscriber interface is an L2TP(LAC) interface, the field contains the address of the LNS. If the subscriber interface is an IP interface on top of an LNS, the field contains the address of the LAC.

  • Type of attribute PAT_OPAQUE
  • TYpes of associated events - All
PA_LOCAL_TUNNEL_INET_ADDRESS 

InetAddress of the local end of an L2TP tunnel.

If the subscriber interface is an L2TP(LAC) interface, the field contains the address of the LAC. If the subscriber interface is an IP interface on top of an LNS, the field contains the address of the LNS.

  • Type of attribute PAT_OPAQUE
  • TYpes of associated events - All
PA_USER_IP_MASK 

Length in bit of the InetAddress of the subscriber.

  • Type of attribute PAT_LONG
  • TYpes of associated events - All
PA_FRAMED_IPV6_PREFIX 

Framed IPv6 Prefix.

The attribute contains the address/prefix in the same format as described in RF3162: the first octet is 0, the second octet contains the length of the prefix, the remaining (length/8) octets contain the significant bits of the prefix.

  • Type of attribute PAT_OPAQUE
  • TYpes of associated events - All
PA_DELEGATED_IPV6_PREFIX 

Delegated IPv6 prefix.

This attribute can occur multiple times, where each instance describes an alternative address/prefix for the subscriber session The format of the attribute value is the same as described in RFC4818: the first octet is 0, the second octet contains the length of the prefix, the remaining (length/8) octets contain the significant bits of the prefix.

  • Type of attribute PAT_OPAQUE
  • TYpes of associated events - All
PA_SERVICE_IDENTIFIER 

3gpp Service identifier attribute.

  • Type of attribute PAT_INT
  • Types of associated events - ServiceTracking, ServiceAuthorization
PA_EVENT_TRIGGER 
  • Type of attribute - PAT_STRING
    • Types of associated events - Tracking
PA_TDF_APP_ID 
  • Type of attribute - PAT_STRING
    • Types of associated events - Tracking
PA_TDF_APP_INSTANCE_ID 
  • Type of attribute - PAT_STRING
    • Types of associated events - Tracking
PA_RATING_GROUP 
  • Type of attribute - PAT_LONG
    • Types of associated events - Service Tracking & Service Authorization
PA_TOTAL_OCTETS 

Number of 64-bit upstream and downstream packets (network -> user).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - UserTracking, ServiceTracking
PA_IPV6_IN_OCTETS 

Number of 64-bit ipv6 upstream octets (user -> network).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - UserTracking, ServiceTracking
PA_IPV6_OUT_OCTETS 

Number of 64-bit ipv6 downstream octets (network -> user).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - UserTracking, ServiceTracking
PA_IPV6_IN_PACKETS 

Number of 64-bit ipv6 upstream packets (user -> network).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - UserTracking, ServiceTracking
PA_IPV6_OUT_PACKETS 

Number of 64-bit ipv6 downstream packets (network -> user).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - UserTracking, ServiceTracking
PA_IPV6_TOTAL_OCTETS 

Number of 64-bit ipv6 upstream and downstream packets (network -> user).

  • Type of attribute - PAT_LONG_LONG
  • Types of associated events - UserTracking, ServiceTracking
PA_last 

Possible encoding types of plug-in attribute types.

Enumerator:
PAT_LONG 

32-bit integer

PAT_LONG_LONG 

64-bit integer

PAT_STRING 

Character string.

PAT_OPAQUE 

Byte array.

Types of events that the SAE sends to the plug-in.

The event type is passed as the first argument in the PluginInterface.authorize() and PluginInterface.track() methods that are implemented by the plug-in.

Enumerator:
PE_AUTH_USER 

authentication and authorization events

UserAuthorization events

PE_AUTH_SERVICE 

ServiceAuthorization events.

PE_AUTH_SUBSCRIPTION 

SubscriptionAuthorization events.

PE_START_USER 

tracking events

Start UserTracking events

PE_STOP_USER 

Stop UserTracking events.

PE_INTERIM_USER 

Interim UserTracking events.

PE_START_SERVICE 

Start ServiceTracking events.

PE_INTERIM_SERVICE 

Interim ServiceTracking events.

PE_STOP_SERVICE 

Stop ServiceTracking events.

PE_START_INTERFACE 

Start InterfaceTracking events.

PE_INTERIM_INTERFACE 

Interim InterfaceTracking events.

PE_STOP_INTERFACE 

Stop InterfaceTracking events.

PE_AUTH_DHCP 

DHCP Authorization events.

PE_no_event 

Generated on 19 Jul 2017 for SAE CORBA Plug-In Service Provider Interface (SPI) by  doxygen 1.6.1