# Note: equal sign ('=') is a key-value separator used by the configuration file therefore it # should be preceded by backslash ('\') in order to be used it as part of the value. # For example, [Sample Section] # key=value1\=value2 [SM General] # The following parameter defines whether the SM introduces the subscribers to the SCEs # immediately after the subscriber's login operation (push-mode) or when the SCE requests # subscriber information specifically (pull-mode). # Optional values: [pull, push]. Default: push. introduction_mode=push # The following parameter defines whether subscriber-related operations (login, # logout etc.) should be locked at the application level. Set this flag to "true" # in cases subscribers can be updated simultaneously by several LEGs. # Note that setting the flag to "true" will cause performance degradation. # Optional values: [true, false]. Default: true. application_subscriber_lock=true # The following parameter defines whether the SM should remove # a subscriber from an SCE when a different SCE indicates that # the subscriber's traffic started to flow through it. By such # an operation the SM forces that a subscriber is handled by # a single SCE at any given time. # This parameter takes effect only in pull mode. # Use this parameter only in N+1 SCE topology when used with a # 7600 switch as a dispatcher # Optional values: [true, false]. Default: false. # SM RESTART REQUIRED force_subscriber_on_one_sce=false # The following parameter defines whether logon events logging to is enabled. # Note that setting the flag to "true" will cause performance degradation. logon_logging_enabled=false # The following parameter defines whether subscriber IDs are case sensitive or not. # When this flag is set to "no", all subscriber IDs are set to lower case # Note: # It is not possible to change this flag to "no" when the subscriber database # is not empty # Optional values: [yes, no]. Default: yes. subscriber_id_case_sensitivity=yes # The following parameter defines the list of prefixes to be used in the pull lookup # operation, when an IPv6 pull request notification received by SM. # The values are comma separated list of supported prefixes in the deployment # subscriber_ipv6_prefixes=64,56 # By default it holds 64 as default prefix and it should be in the range [32 to 64] # Note: # -Change in the value REQUIRES SM RESTART # -Lookup order is always from higher to lower prefixes value subscriber_ipv6_prefixes=64 [SM High Availability Setup] # Determines in what topology the SM should work with. # Optional values : [standalone, cluster]. Default: standalone. topology=standalone [SM-LEG Failure Handling] # The following parameter defines the behavior of the SM in case of LEG-SM connection failure. # This parameter is relevant only for cases SM and LEG are running on different machines. # Note that this parameter defines a behavior that is similar for ALL connected LEGs. # If the parameter is set to true then in case of LEG-SM connection failure that is not # recovered within the defined timeout, the mappings of all subscribers in the domains # defined in the 'LEG-Domains Association' section for the LEG that was disconnected, # will be removed # # IMPORTANT: LEG Domains must be defined in the following section in case this parameter is set to 'true' # # Optional values: [true/false]. Default: false. #clear_all_mappings=false clear_all_mappings=true # The following parameter defines the time in seconds from a LEG-SM connection # failure until clearing the mappings in the SM database. # Default value: 60. timeout=60 [LEG-Domains Association] # The following parameter defines domains that the mapping of all subscribers that belong # to them will be cleared on LEG-SM connection failure. # The key is the LEG NAME and the value is a comma separated list of domain names. # # A value of * in domain names stands for all the subscriber domains in the system. # A value of * in LEG name means all the LEGs that are connected to the SM # LEG NAME1 = domain_name1,domain_name2 # LEG NAME2 = domain_name2,domain_name3 # Each domain section specifies one domain. # The format of the domain section clause is Domain.XXX when XXX represents the # domain name #[Domain.XXX] #[Domain.VTC] #elements=VTC_SCE_VL #aliases=* # The following parameter specifies the names of the SCE boxes that are part of the # domain. Make sure the name is the exact name (case sensitive) that appears in the SCE section. # elements= # The following parameter defines domain aliases. When subscriber information is received # from the LEG with certain alias the information will be distributed to the domain that # matches this alias - domain that contains this alias in its aliases list. # # A typical alias could be a network device IP address. For example, each string # in the values can be the IP address of a NAS or a CMTS. # For SCE-Sniffer LEGs a typical alias could be the IP address of the SCE that sniffs the # traffic # # In order to distribute all subscriber operations on all unmapped domains to a certain # domain use aliases=*. Note that only one domain section may include this alias. # aliases= # The following parameter defines the default policy properties values for a domain. # Unless these defaults are overridden by the LEG / API when it introduces # the subscriber to the SM, the subscriber's policy is set according to the default # policy properties values of its domain. # The policy format is a comma separated list of '"property-name-property-value"' # To learn more about policy specification read the SCA-BB user guide # property. = [Default Domains Configuration] # The following parameter defines default policy for the domain. It will be used for # domains that no policy was defined for them in the previous section. # property. = [Auto Logout] # The following parameter configures the time between each run of the # auto-logout mechanism. After every "auto-logout" time interval, the SM # checks which subscriber IP addresses have a lease time that has expired, # and begins to automatically remove these IP addresses from the system # (causing it to be removed from the SCE platform's database). # the auto-logout mechanism is activate when the timeout is set to value greater than zero. # # Auto-logout should be activated when the LEG/API can't provide logout indications. # (default 0) auto_logout_interval=0 # The following parameter defines the grace period in seconds for subscriber auto logout. # A subscriber will be logged out only after lease period + grace period seconds. grace_period=10 # The following parameter defines the maximum rate (logouts per second) that the auto-logout # task will perform logouts from the system. this enables to spread the load of the logout # operations over time, and reduce the performance impact on other operations. # the value should be calculated so it spreads the logouts over all least half of # 'auto_logout_interval' time. (default 50) max_rate=50 # defines whether to issue user-log messages for each auto logout events # possible values true or false # Default false log_auto_logouts=false # the following section defines the functionality of removing # subscribers that have no network-Id for a certain time [Inactive Subscriber Removal] # defines whether to perform removal of inactive subscribers. # possible values yes, no, true or false # Default no #start=no # defines the time threshold after which if the subscriber is not # assigned any network-Id it should be removed from the SM # database. # Possible values: "X minutes", "X hours", "X days" or # "X weeks" when X represents a decimal number. # Default: 1 hour. #inactivity_timeout=1 hour # defines the maximum number of subscribers per second that # may be removed by the removal task. # default 10 #max_removal_rate=10 # defines whether to issue user-log messages for each subscriber # record removal. # possible values true or false # Default true #log_removals=true [Radius Listener] # The following parameter defines whether the SM should run the Radius Listener at # startup. Receives the values: yes, no. (default no) start=no #The following parameter defines whether the SM should process IPv6 fields from Radius #packets. Receives the values yes,no(default no) enable_ipv6=no # accounting port number (default 1813) accounting_port=1813 # IP address that the RADIUS Listener should bind to. use this parameter only in cases # where the IP address used for RADIUS transactions is not the main IP address of the # SM machine. for example in cluster topologies. # Default: not set #ip= # RADIUS protocol packet types to analyze # Optional values: "accounting-start", "accounting-interim", "accounting-stop" # separated with ','. # (Default: accounting-start,accounting-interim,accounting-stop) packet_types=accounting-start,accounting-interim,accounting-stop # The following parameter update the lease time (Interim_aging_timeout) for each # IP addresses received from the radius packets. # After every [Auto Logout] time interval, # the SM checks which subscriber IP addresses have a lease time that has expired, # and begins to automatically remove these IP addresses from the system # (causing it to be removed from the SCE platform's database). # To enable this the auto-logout mechanism should be activated. # The interim-aging mechanism is activate when the interim_aging_timeout is set to value # greater than zero. # Unit of measurement for this parameters is hours. # (default 0) interim_aging_timeout=0 # Each NAS section specifies single Network Access System. # The format of the NAS section clause is NAS.XXX when XXX represents the # NAS name. #[Radius.NAS.YYY] # Cisco Service Control's subscriber domain name # domain = # IP address in dotted notation # IP_address = # name of the NAS that exists in the NAS-ID attribute # NAS_identifier = # secret string # secret = # This section defines the RADIUS attribute on which subscriber ID association is # based. Default association is based on the 'user name' attribute. Uncomment this # section if you want to base subscriber ID association on a different attribute. [Radius.Subscriber ID] # Radius protocol fields name. # for multiple fields, use commas between the field name. # field name shall not start or end with space bar, name shall not contain "=" char. # Note - it is mandatory to create [Radius.Field.] section for each # field defined in fields property # (default: user_name) # fields= ,, fields= # character used in concatenation of several fields default value is _ # the value shall be field_separator= # The following parameters define ways to manipulate the RADIUS # field values. # # To define manipulation operation use the following format: # field_manipulation.. # 1. is one of the fields defined in fields. # 2. is the reduction regular expression for # the # It is possible to define field_manipulation rule for each field_name, # (.*) stands for non reduction requirement, is the default rule in case there # is a non configured field manipulation. # #field_manipulation.= # This section defines the RADIUS attribute on which subscriber # IP Address is based. Default association and fall-back is based on the # 'Framed-Route' or if does not exists the 'Framed-IP-Address' attribute. # Uncomment this section if you want to base subscriber IP Address on # a different attribute. # the configured attribute can be of type string or integer. [Radius.Subscriber IP Address] # Radius protocol fields name for IP. # (default: not-set) # field name shall not start or end with space bar, name shall not contain "=" char. # Note - it is mandatory to create [Radius.Field.] section for the field you define. fields= # Radius protocol fields name for VPN. # field name shall not start or end with space bar, name shall not contain "=" char. # Note - it is mandatory to create [Radius.Field.] section for the field you define. vpn_field= # This section defines the RADIUS attribute on which subscriber # IPv6 Address is based. Default association is based on the # 'Framed-IPv6-Prefix' or if does not exists the 'Framed-IPv6-Route' attribute. # Uncomment this section if you want to base subscriber IPv6 Address on # a different attribute. # SM will process this section only if enable_ipv6 property is set to true. # the configured attribute can be of type ipv6_prefix or string. [Radius.Subscriber IPv6 Address] # Radius protocol fields name for IPv6. # (default: not-set) # field name shall not start or end with space bar, name shall not contain "=" char. # Note - it is mandatory to create [Radius.Field.] section for the field you define. fields= # [Radius.Property.Package] # This section defines RADIUS attribute from which subscriber package is retrieved. # Uncomment this section if you want to retrieve subscriber package from a different attribute. # Radius protocol fields name. # for multiple fields, use commas between the field name. # field name shall not start or end with space bar, name shall not contains "=" char. # Note - it is mandatory to create [Radius.Field.] section for each # field defined in fields property # (default: user_name) # fields= ,, # character used in concatenation of several fields default value is _ # the value shall be #field_separator= # The following parameters define ways to manipulate the RADIUS # field values. # # To define manipulation operation use the following format: # field_manipulation.. # 1. is one of the fields defined in fields. # 2. is the reduction regular expression for # the # It is possible to define field_manipulation rule for each field_name, # (.*) stands for non reduction requirement, is the default rule in case there # is a non configured field manipulation. # #field_manipulation.= # To define the interim login policy use the following format: # (default value: false) #skip_policy_update_on_interim=false # the following parameter define a conversion table between the # result of the attribute value manipulation, the matching rule and the property # value. To define this conversion uses the following format: # mapping_table.= # Regular Expression Matching Rule # Integer result in case of match. # defaults: user can define <.*> to be the default value incase there is no match. # # for example: # mapping_table.^gold$=1 # mapping_table.silver=2 # # mapping_table.= # the following parameter defines whether a login with no policy is allowed # in case that no policy is found for the assignment # (Default=false) #allow_login_with_no_policy=false # a list of policy Ids separated by coma. # During login if the current policy Id is one of the policy Id defined # in the list,login operation will happen with no policy change. #ignore_policy_list= # the following parameters defines whether to assign a default policy ID # and the default value to use in a case where we cannot associate the created policy name # with any of the configured policy-names from the list below. # (Default: use_default=false) #use_default=false # the following parameter defines the default policy ID to use if no policy information is extracted. # this parameter is relevent only if the use_default parameter is set to true. # (Default : default_policy=0) #default_policy=0 # [Radius.Property.upVlinkId] # This section defines RADIUS attribute from which subscriber upVlinkId is # retrieved. # Uncomment this section if you want to retrieve subscriber upVlinkId from # a different attribute. # Radius protocol fields name. # field name shall not start or end with space bar, name shall not contains # "=" char. # Note - it is mandatory to create [Radius.Field.] section # for each field defined in fields property # (default: user_name) # fields= # Property name is upVlinkId is used to assign the subscribers virtual link # id name # property name for UpvlinkId property iS fixed # property_name = upVlinkId # property type for upvlinkId is used to set the type of value receiving from # the radius packets is mapped here # property_type = # The following parameters define ways to manipulate the RADIUS # field values. # # To define manipulation operation use the following format: # field_manipulation.. # 1. is one of the fields defined in fields. # 2. is the reduction regular expression for # the # It is possible to define field_manipulation rule for each field_name, # (.*) stands for non reduction requirement, is the default rule in case # there is a non configured field manipulation. #field_manipulation.= # To define the interim login policy use the following format: # (default value: false) #skip_policy_update_on_interim=false # the following parameter define a conversion table between the # result of the attribute value manipulation, the matching rule # and the property value. To define this conversion uses # the following format: # mapping_table.= # Regular Expression Matching Rule # ?Integer result in case of match. # defaults: user can define <.*> to be the default value incase # there is no match.It is mandatory to have a mapping to match a # wildcard (mapping_table..*=0) which will map to value �0� for # upVlinkId, as like if there is no exact match found in mapping table # the default value should be �0� always. # for example: # mapping_table.^gold$=1 # mapping_table.silver=2 # mapping_table..*=0 # # mapping_table.= #[Radius.Property.downVlinkId] # This section defines RADIUS attribute from which subscriber downVlinkId # is retrieved. # Uncomment this section if you want to retrieve subscriber downVlinkId # from a different attribute. # Radius protocol fields name. # field name shall not start or end with space bar, name shall not # contains "=" char. # Note - it is mandatory to create [Radius.Field.] # section for each field defined in fields property # (default: user_name) # fields= # Property name is downVlinkId is used to assign the subscribers virtual # link id name # property name for downvlinkId property iS fixed # property_name = downVlinkId # property type for downvlinkId is used to set the type of value # receiving from the radius packets is mapped here # property_type = # The following parameters define ways to manipulate the RADIUS # field values. # # To define manipulation operation use the following format: # field_manipulation.. # 1. is one of the fields defined in fields. # 2. is the reduction regular expression for # the # It is possible to define field_manipulation rule for each field_name, # (.*) stands for non reduction requirement, is the default rule # in case there is a non configured field manipulation. # #field_manipulation.= # To define the interim login policy use the following format: # (default value: false) #skip_policy_update_on_interim=false # the following parameter define a conversion table between the # result of the attribute value manipulation, the matching rule and # the property value. To define this conversion uses the # following format: # mapping_table.= # Regular Expression Matching Rule # ?Integer result in case of match. # defaults: user can define <.*> to be the default value incase # there is no match.It is mandatory to have a mapping to match a # wildcard (mapping_table..*=0) which will map to value �0� for # downVlinkId, as like if there is no exact match found in mapping table # the default value should be �0� always. # # for example: # mapping_table.^gold$=1 # mapping_table.silver=2 # mapping_table..*=0 # # mapping_table.= # This section defines field definition. # Copy and uncomment this this section for each field defined in # fields property, # (fields property can be define in the following sections: # - Subscriber ID # - Subscriber IP # - Radius.Property # Radius protocol attribute number . # [Radius.Field.] # Radius protocol attribute number . # use the following format for VSAs: 26(vendor-id;sub-attribute) # for example: 26(9;1) #radius_attribute = 8 # the type of the attribute (type "integer" or "string") # radius_attribute_type = integer # This section defines the Radius Attributes. # This section defines which all RADIUS attribute needs to be # persisted in SM Database and to send them to SCE. # Uncomment this section if you want to retrieve the subscriber # attributes from the packet. # [Radius.Subscriber Attributes] # RADIUS protocol attributes to process #attributes_list=,,..... # To enable/disable this feature. Permitted values are true & false, # by default this is false. #enable_extended_vsa_support=false. # All the attributes defined in attribute_list needs to have #[Radius.Field.] section, # semaintics for defining the respective field section are similar to the # previous one which are said in # [Radius.Field.] section, but in the "radius_attribute_type", # apart from the type "integer" or "string" # additionally it can have "ip_address" or "binary" # Note: all the attributes defined in the attribute_list needs to be # configured in the SCE as well, refer to SCE mannuals # for configuring the attributes. # Each SCE section represents single SCE box. # The format of the SCE section clause is SCE.XXX when XXX represents the # SCE logical # name. [SCE.VTC_SCE_VL] # The following parameter defines IP address of the SCE box ip=192.168.6.16 port=14374 # The following parameter defines port through which to connect to the SCE box # Default: 14374 # port= # The following [CM.XXX] is relevant for the Virtual Link Manager module # Each CM section represents single Collection Manager. # The format of the CM section clause is CM.XXX when XXX represents the CM name. # [CM.VTC_CM_VL] # The following parameter defines IP address of the CM box # ip=192.168.6.21 # port=14375 # sce_list=VTC_SCE_VL # The following parameter defines port through which to connect to the CM box # Default: 14375 # port= # The following parameter defines list of SCE which are report to the CM. # Each SCE Logical Name mast have a relevant [SCE.xxx] section in the configuration file. # Default: none # sce_list=,... [RPC.Server] # RPC server port (default 14374) port=14374 # full - Force authentication on all connections. # semi - authenticate all connection that support authentication and accept every connections # that do not. # none - non authentication is enforced. # (default semi) security_level=semi # Number of connections supported by the server. # when increasing this value please check the SM User Guide for the required # memory requirements for this operation. # (default 20) maxconnections=20 [FTP] # SM manages internal FTP server for various purposes. The following parameter # determines whether the SM should run the FTP Server at startup. # Receives the values: yes, no. (default no) start=no # FTP server port (default 21000) port=21000 # Following parameters define TCP ports range when FTP server # works in passive mode. Uncomment these parameters when working # with FTP server via firewall. #first_passive_port = 21001 #last_passive_port = 21100 [HTTP Tech-IF] # SM manages internal HTTP adaptor server that is a technician interface. The following # parameter determines whether the SM should run the interface at # startup. Receives the values: yes, no. (default yes). # Note that this is a technician interface and normally it should not be used start=yes # HTTP server port (default 8082) port=8082 [RDR Server] # whether to run the RDR Server # (Default: no) start=yes # the port to listen on for incoming connections # (Default: 33001) port=33001 # the maximum of incoming connections to support # (Default: 10) max_connections=10 [Cable Adaptor] # SM manages Cable Adaptor - special cable support module - that is a translator # between the cable world (DHCP events) and the SM. # Following parameter defines whether logins from unknown # CM are allowed. Optional values: yes/no (default: no) allow_dynamic_CM=no [Data Repository] # The following parameters define the SM's operation with the Times-Ten # In-Memory Database. # Note: some of the following parameter require restart of the SM, and # are discarded on regular configuration loading. such parameters are marked # with "REQUIRES SM RESTART". # # The following parameter determines whether the SM supports IP-Ranges # disabling this support will provide better performance. # REQUIRES SM RESTART (default: no) support_ip_ranges=yes # The following parameter determines the maximum IP range size used in the system. # this parameter is used to improve performance of the SM in pull mode when the # data-repository is configured with support_ip_ranges=yes. # defining this value too low may cause incorrect operation in handling pull requests. # (default: 256) max_range_size=256 # The following parameter defines the interval in seconds for calling the # Times-Ten check-points. reducing this value will affect performance, # increase of this value will increase vulnerability to power-down. # (default: 60) checkpoint_interval_in_seconds=60 # The following parameter determines the maximum number of subscribers supported by the SM. # this parameter is used to create database indices and to determine database table sizes. # you can enlarge this value but not decrease it. # REQUIRES SM RESTART (default: 200000) max_number_of_subscribers=200000 # The following parameter define the subscriber cache size. # The cache is used to optimize the database transactions. it should be set to # the number of the active subscribers which are updated by management systems # in high frequency. # REQUIRES SM RESTART (default: 100000) cache_size=100000 # The following parameter determines the maximum number of VPNs supported by the SM. # this parameter is used to create database indices and to determine database table sizes. # you can enlarge this value but not decrease it. # REQUIRES SM RESTART (default: 2048) max_number_of_vpns=2048 # The following parameter define the VPN cache size. # The cache is used to optimize the database transactions. it should be set to # the number of the active VPNs which are updated by management systems # in high frequency. # REQUIRES SM RESTART (default: 2048) vpn_cache_size=2048 # The following parameters define the SM's operation with the MPLS-VPN support. [MPLS-VPN] # The following parameter determines failed in the BGP messages that should be used # for MPLS-VPN identification, in correlation to the MPLS-VPN mappings that were # previously set to the SM. # possible values: "rd" or "rt". # (default: rt) vpn_id=rt # The following parameter turns on detailed logging of messages received from the BGP LEG # should be changed to true only during troubleshooting # (default: false) log_all=false # The following parameters define the Quota Manager configuration [Quota Manager] # The following parameter determines whether the Quota Manager should run at startup. # Receives the values: yes, no. (default no) start=yes # The following parameter determines whether to keep history cross global profiles # (default: true) reset_quota_on_profile_switch=true # The following parameter determines whether to keep history cross penalty profiles # (default: false) #reset_quota_on_penalty_profile_switch=false reset_quota_on_penalty_profile_switch=true # The following parameter determines whether to allow subscriber to come out of penalty on aggregation period end. # (default: false) handle_out_of_penalty_on_aggregation_period_end=false # Logging to user-log parameters: # log-all - logs everything (default: false) # log-failures - logs only errors (default: true) # log_breach_events - logs only events of subscriber bucket breach and # new aggregation period (default: false) log_failures=true log_all=false log_breach_events=false # The following parameter enables accounting of quota notifications that the Quota Manager has received specific to # bucket ids and the last quota provisioning time.It is applicable to multibucket quota profile configurations only. # (default: false) handle_multi_bucket_in_grace_period=false # The following parameter determines whether to enable quota management over multiple sce(true/false). # (default: false) #multiple_sce_support=false # The following parameter determines which flavor for allocating the quota when quota over multiple sce is enabled. #Supported flavors are consumption/ provisioned # (default: consumption) #quota_allocation_based_on=consumption