Common subscriber services Python API

Table: Subscriber service functions in the alc.sub_svc module lists the subscriber service functions in the alc.sub_svc module.

Table: Subscriber service functions in the alc.sub_svc module
sub_svc functions Description

sub_svc.add_to_service (svc, sub_svc TLV, value)

Appends a TLV to the service list. The service list describes the subscriber service and should be passed to the sub_svc.commit_service() to activate or deactivate the subscriber service.

Parameters:

svc (type = list): service list that describes the subscriber service. sub_svc TLVs are appended to this list with the sub_svc.add_to_service() function.

sub_svc TLV (type int): TLV that is appended to the service list

value (type as defined for the sub_svc TLV): the value of the sub_svc TLV that is appended to the service list

sub_svc.commit_service (svc)

Creates the required internal VSAs based on the TLVs provided in the svc list.

Parameters:

svc (type = list): service list that describes the subscriber service. sub_svc TLVs are appended to this list with the sub_svc.add_to_service() function. The service list should be passed to sub_svc.commit_service() to activate or deactivate the subscriber service.

Table: Subscriber service TLVs in the alc.sub_svc module lists the subscriber service TLVs in the alc.sub_svc module.

Table: Subscriber service TLVs in the alc.sub_svc module
sub_svc TLV Activate/ deactivate TLV details

name

(string)

M/M

Purpose

The unique subscriber service instance identifier (key). This field is matched for a subscriber service deactivate request.

This field could, for example, be populated with the service-name and corresponding parameter list.

This value is also echoed in the Alc-Sub-Serv-Session attribute in accounting messages.

When not specified, the subscriber service activation fails and an event log is generated: WARNING: SVCMGR #2511 Base RADIUS CoA Error ‟Problem encountered in Subscriber Management, while processing a CoA request from a RADIUS server: Could not decode RADIUS Attribute ‟Sub Service””.

Value

Free format string (max. length = 1000 bytes)

Default

Empty string

operation

(int)

M/O

Purpose

Specifies if the referenced subscriber service should be activated or deactivated

Value

operation_add (1): activate the subscriber service instance

operation_del (2): deactivate the subscriber service instance

Default

operation_del

acct_stats_type

(int)

O/n.a.

Purpose

Defines if RADIUS accounting should be enabled for this subscriber service instance. If enabled, the accounting mode (Time or Volume and Time) is specified.

Values as defined for Alc-Sub-Serv-Acct-Interim-Ivl VSA

Value

Off (1)

Volume-time (2)

Time (3)

Default

Off

acct_interval

(int)

O/n.a.

Purpose

Defines the RADIUS interim accounting update interval for this subscriber service instance

Values as defined for Alc-Sub-Serv-Acct-Interim-Ivl VSA

Value

0 (no interim updates)

1 to 299 (rounded to a maximum 300 seconds)

300 to 15552000 (override the local configured update-interval for this subscriber service instance)

Default

Update interval from the parent subscriber RADIUS accounting policy

type

(string)

O/n.a.

Purpose

Grouping of subscriber service instances that belong to the same PPPoE or IPoE session

Value

Free format string (max. length = 255 bytes)

Default

empty string

type_conflict_action

(int)

O/n.a.

Purpose

Defines the action when another subscriber service instance of the same type is already activated for the same PPPoE or IPoE session.

Value

type_conflict_action_keep_old (1): reject the new subscriber service instance

type_conflict_action_keep_new (2): deactivate the old and activate the new subscriber service instance

type_conflict_action_none (3): allow multiple subscriber service instances of this type

Default

type_conflict_action_none

Note: M=Mandatory, O=Optional, n.a.=ignored